 |
F´ Flight Software - C/C++ Documentation
NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
|
Go to the documentation of this file.
63 #if FW_QUEUE_REGISTRATION
77 #if FW_QUEUE_REGISTRATION
QueueStatus create(const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
create a message queue
@ QUEUE_FULL
queue was full when attempting to send a message
NATIVE_INT_TYPE getMsgSize() const
get the message size (maximum message size queue can hold)
uint8_t U8
8-bit unsigned integer
NATIVE_INT_TYPE getMaxMsgs() const
get the maximum number of messages (high watermark)
POINTER_CAST m_handle
handle for implementation specific queue
@ QUEUE_EMPTY_BUFFER
supplied buffer is empty
NATIVE_INT_TYPE getNumMsgs() const
get the number of messages in the queue
@ QUEUE_INVALID_PRIORITY
invalid priority requested
QueueStatus send(const Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE priority, QueueBlocking block)
send a message
@ QUEUE_SIZE_MISMATCH
attempted to send or receive with buffer too large, too small
QueueStatus receive(Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE &priority, QueueBlocking block)
receive a message
@ QUEUE_UNINITIALIZED
Queue wasn't initialized successfully.
QueueString m_name
queue name
const QueueString & getName()
get the queue name
@ QUEUE_NO_MORE_MSGS
If non-blocking, all the messages have been drained.
@ QUEUE_OK
message sent/received okay
static NATIVE_INT_TYPE s_numQueues
tracks number of queues in the system
NATIVE_INT_TYPE getQueueSize() const
get the queue depth (maximum number of messages queue can hold)
virtual void regQueue(Queue *obj)=0
method called by queue init() methods to register a new queue
@ QUEUE_RECEIVE_ERROR
message receive error
@ QUEUE_UNKNOWN_ERROR
Unexpected error; can't match with returns.
@ QUEUE_NONBLOCKING
Queue receive always returns even if there is no message.
@ QUEUE_SEND_ERROR
message send error
Declarations for Fw::ObjBase and Fw::ObjRegistry.
QueueStatus createInternal(const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
create a message queue
Declares ISF basic types.
int NATIVE_INT_TYPE
native integer type declaration
static NATIVE_INT_TYPE getNumQueues()
get the number of queues in the system
@ QUEUE_BLOCKING
Queue receive blocks until a message arrives.