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

Contains attributes of a Queue. More...

#include <queue_attributes.h>

Public Member Functions

 QueueAttributes ()
 Constructs a QueueAttributes object. More...
 
QueueAttributesSetGlobal (bool state)
 Sets the global property of a Queue. More...
 
QueueAttributesSetOrdered (bool state)
 Sets the ordered property of a Queue. More...
 
QueueAttributesSetRetain (bool state)
 Sets the retain property of a Queue. More...
 
QueueAttributesSetDomainShared (bool state)
 Sets the domain shared property of a Queue. More...
 
QueueAttributesSetPriority (mtapi_uint_t priority)
 Sets the priority of a Queue. More...
 
QueueAttributesSetLimit (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...
 

Detailed Description

Contains attributes of a Queue.

Constructor & Destructor Documentation

embb::mtapi::QueueAttributes::QueueAttributes ( )

Constructs a QueueAttributes object.

Concurrency
Not thread-safe

Member Function Documentation

QueueAttributes& embb::mtapi::QueueAttributes::SetGlobal ( bool  state)

Sets the global property of a Queue.

This determines whether the object will be visible across nodes.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
stateThe 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.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
stateThe 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.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
stateThe 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.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
stateThe 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.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
priorityThe priority to set.
QueueAttributes& embb::mtapi::QueueAttributes::SetLimit ( mtapi_uint_t  limit)

Sets the limit (capacity) of a Queue.

Returns
Reference to this object.
Concurrency
Not thread-safe
Parameters
limitThe 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.

Returns
A reference to the internal mtapi_queue_attributes_t structure.
Concurrency
Thread-safe and wait-free