Embedded Multicore Building Blocks V1.0.0
Public Member Functions | List of all members
embb::mtapi::Action Class Reference

Holds the actual worker function used to execute a Task. More...

#include <action.h>

Public Member Functions

 Action ()
 Constructs an Action. More...
 
 Action (Action const &other)
 Copies an Action. More...
 
Actionoperator= (Action const &other)
 Copies an Action. More...
 
void Delete ()
 Deletes an Action. More...
 
mtapi_action_hndl_t GetInternal () const
 Returns the internal representation of this object. More...
 

Detailed Description

Holds the actual worker function used to execute a Task.

Constructor & Destructor Documentation

embb::mtapi::Action::Action ( )

Constructs an Action.

The Action object will be invalid.

Concurrency
Thread-safe and wait-free
embb::mtapi::Action::Action ( Action const &  other)

Copies an Action.

Concurrency
Thread-safe and wait-free
Parameters
otherAction to copy

Member Function Documentation

Action& embb::mtapi::Action::operator= ( Action const &  other)

Copies an Action.

Returns
Reference to this object.
Concurrency
Thread-safe and wait-free
Parameters
otherAction to copy
void embb::mtapi::Action::Delete ( )

Deletes an Action.

Concurrency
Thread-safe
mtapi_action_hndl_t embb::mtapi::Action::GetInternal ( ) const

Returns the internal representation of this object.

Allows for interoperability with the C interface.

Returns
The internal mtapi_action_hndl_t.
Concurrency
Thread-safe and wait-free