Embedded Multicore Building Blocks V1.0.0
|
Contains attributes of a Queue. More...
#include <queue_attributes.h>
Public Member Functions | |
QueueAttributes () | |
Constructs a QueueAttributes object. More... | |
QueueAttributes & | SetGlobal (bool state) |
Sets the global property of a Queue. More... | |
QueueAttributes & | SetOrdered (bool state) |
Sets the ordered property of a Queue. More... | |
QueueAttributes & | SetRetain (bool state) |
Sets the retain property of a Queue. More... | |
QueueAttributes & | SetDomainShared (bool state) |
Sets the domain shared property of a Queue. More... | |
QueueAttributes & | SetPriority (mtapi_uint_t priority) |
Sets the priority of a Queue. More... | |
QueueAttributes & | SetLimit (mtapi_uint_t limit) |
Sets the limit (capacity) of a Queue. More... | |
mtapi_queue_attributes_t const & | GetInternal () const |
Returns the internal representation of this object. More... | |
Contains attributes of a Queue.
embb::mtapi::QueueAttributes::QueueAttributes | ( | ) |
Constructs a QueueAttributes object.
QueueAttributes& embb::mtapi::QueueAttributes::SetGlobal | ( | bool | state | ) |
Sets the global property of a Queue.
This determines whether the object will be visible across nodes.
state | The state to set. |
QueueAttributes& embb::mtapi::QueueAttributes::SetOrdered | ( | bool | state | ) |
Sets the ordered property of a Queue.
If set to true
, tasks enqueued will be executed in order.
state | The state to set. |
QueueAttributes& embb::mtapi::QueueAttributes::SetRetain | ( | bool | state | ) |
Sets the retain property of a Queue.
If set to true
, tasks will be retained while a queue is disabled. Otherwise the will be canceled.
state | The state to set. |
QueueAttributes& embb::mtapi::QueueAttributes::SetDomainShared | ( | bool | state | ) |
Sets the domain shared property of a Queue.
This determines whether the object will be visible across domains.
state | The state to set. |
QueueAttributes& embb::mtapi::QueueAttributes::SetPriority | ( | mtapi_uint_t | priority | ) |
Sets the priority of a Queue.
The priority influences the order in which tasks are chosen for execution.
priority | The priority to set. |
QueueAttributes& embb::mtapi::QueueAttributes::SetLimit | ( | mtapi_uint_t | limit | ) |
Sets the limit (capacity) of a Queue.
limit | The limit to set. |
mtapi_queue_attributes_t const& embb::mtapi::QueueAttributes::GetInternal | ( | ) | const |
Returns the internal representation of this object.
Allows for interoperability with the C interface.