HiCR::backend::boost::ExecutionState Class Reference

#include <executionState.hpp>

Inheritance diagram for HiCR::backend::boost::ExecutionState:

Public Member Functions
__INLINE__	ExecutionState (const std::shared_ptr< HiCR::ExecutionUnit > &executionUnit, void *const argument=nullptr)
Public Member Functions inherited from HiCR::ExecutionState
__INLINE__ void	resume ()
__INLINE__ void	suspend ()
__INLINE__ bool	checkFinalization ()
__INLINE__ state_t	getState ()
	ExecutionState ()=delete
virtual	~ExecutionState ()=default

Protected Member Functions
__INLINE__ void	resumeImpl () override
__INLINE__ void	suspendImpl () override
__INLINE__ bool	checkFinalizationImpl () override
Protected Member Functions inherited from HiCR::ExecutionState
	ExecutionState (const std::shared_ptr< HiCR::ExecutionUnit > &executionUnit)

Additional Inherited Members
Public Types inherited from HiCR::ExecutionState
enum	state_t {   uninitialized , initialized , running , suspended ,   finished }

Detailed Description

This class represents the execution state of a resumable function for the Boost backend. It uses a coroutine object to enable suspend/resume functionality.

Constructor & Destructor Documentation

ExecutionState()

__INLINE__ HiCR::backend::boost::ExecutionState::ExecutionState ( const std::shared_ptr< HiCR::ExecutionUnit > &  executionUnit, void *const  argument = nullptr  )

inline

Creates a new suspendable execution state (coroutine) for execution based on a Boost execution unit

Parameters

[in]	executionUnit	The replicable stateless execution unit to instantiate
[in]	argument	Argument (closure) to pass to the function to be ran

Member Function Documentation

checkFinalizationImpl()

__INLINE__ bool HiCR::backend::boost::ExecutionState::checkFinalizationImpl ( )

inlineoverrideprotectedvirtual

Backend-specific implementation of the checkFinalization function

Returns

True, if the execution has finalized; False, otherwise.

Implements HiCR::ExecutionState.

resumeImpl()

__INLINE__ void HiCR::backend::boost::ExecutionState::resumeImpl ( )

inlineoverrideprotectedvirtual

Backend-specific implementation of the resume function

Implements HiCR::ExecutionState.

suspendImpl()

__INLINE__ void HiCR::backend::boost::ExecutionState::suspendImpl ( )

inlineoverrideprotectedvirtual

Backend-specific implementation of the suspend function

Implements HiCR::ExecutionState.

---

The documentation for this class was generated from the following file:

• /home/runner/work/HiCR/HiCR/include/hicr/backends/boost/executionState.hpp