#include <Os/IPCQueue.hpp>

Inheritance diagram for Os::IPCQueue:

Public Member Functions
	IPCQueue ()

	~IPCQueue ()

QueueStatus	create (const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
	create a message queue More...

QueueStatus	send (const Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE priority, QueueBlocking block)
	send a message More...

QueueStatus	receive (Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE &priority, QueueBlocking block)
	receive a message More...

QueueStatus	send (const U8 *buffer, NATIVE_INT_TYPE size, NATIVE_INT_TYPE priority, QueueBlocking block)
	send a message More...

QueueStatus	receive (U8 *buffer, NATIVE_INT_TYPE capacity, NATIVE_INT_TYPE &actualSize, NATIVE_INT_TYPE &priority, QueueBlocking block)
	receive a message More...

NATIVE_INT_TYPE	getNumMsgs () const
	get the number of messages in the queue More...

NATIVE_INT_TYPE	getMaxMsgs () const
	get the maximum number of messages (high watermark) More...

NATIVE_INT_TYPE	getQueueSize () const
	get the queue depth (maximum number of messages queue can hold) More...

NATIVE_INT_TYPE	getMsgSize () const
	get the message size (maximum message size queue can hold) More...

Public Member Functions inherited from Os::Queue
	Queue ()

virtual	~Queue ()

QueueStatus	create (const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
	create a message queue More...

QueueStatus	send (const Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE priority, QueueBlocking block)
	send a message More...

QueueStatus	receive (Fw::SerializeBufferBase &buffer, NATIVE_INT_TYPE &priority, QueueBlocking block)
	receive a message More...

QueueStatus	send (const U8 *buffer, NATIVE_INT_TYPE size, NATIVE_INT_TYPE priority, QueueBlocking block)
	send a message More...

QueueStatus	receive (U8 *buffer, NATIVE_INT_TYPE capacity, NATIVE_INT_TYPE &actualSize, NATIVE_INT_TYPE &priority, QueueBlocking block)
	receive a message More...

NATIVE_INT_TYPE	getNumMsgs () const
	get the number of messages in the queue More...

NATIVE_INT_TYPE	getMaxMsgs () const
	get the maximum number of messages (high watermark) More...

NATIVE_INT_TYPE	getQueueSize () const
	get the queue depth (maximum number of messages queue can hold) More...

NATIVE_INT_TYPE	getMsgSize () const
	get the message size (maximum message size queue can hold) More...

const QueueString &	getName ()
	get the queue name More...

Additional Inherited Members
Public Types inherited from Os::Queue
enum	QueueStatus { QUEUE_OK , QUEUE_NO_MORE_MSGS , QUEUE_UNINITIALIZED , QUEUE_SIZE_MISMATCH , QUEUE_SEND_ERROR , QUEUE_RECEIVE_ERROR , QUEUE_INVALID_PRIORITY , QUEUE_EMPTY_BUFFER , QUEUE_FULL , QUEUE_UNKNOWN_ERROR }

enum	QueueBlocking { QUEUE_BLOCKING , QUEUE_NONBLOCKING }

Static Public Member Functions inherited from Os::Queue
static NATIVE_INT_TYPE	getNumQueues ()
	get the number of queues in the system More...

Protected Member Functions inherited from Os::Queue
QueueStatus	createInternal (const Fw::StringBase &name, NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
	create a message queue More...

Protected Attributes inherited from Os::Queue
POINTER_CAST	m_handle
	handle for implementation specific queue More...

QueueString	m_name
	queue name More...

Static Protected Attributes inherited from Os::Queue
static NATIVE_INT_TYPE	s_numQueues = 0
	tracks number of queues in the system More...

Detailed Description

Definition at line 7 of file IPCQueue.hpp.

Constructor & Destructor Documentation

◆ IPCQueue()

Os::IPCQueue::IPCQueue ( )

Definition at line 54 of file IPCQueueStub.cpp.

◆ ~IPCQueue()

Os::IPCQueue::~IPCQueue ( )

Definition at line 85 of file IPCQueueStub.cpp.

Member Function Documentation

◆ create()

Queue::QueueStatus Os::IPCQueue::create	(	const Fw::StringBase &	name,
		NATIVE_INT_TYPE	depth,
		NATIVE_INT_TYPE	msgSize
	)

create a message queue

Definition at line 57 of file IPCQueueStub.cpp.

◆ getMaxMsgs()

NATIVE_INT_TYPE Os::IPCQueue::getMaxMsgs ( ) const

get the maximum number of messages (high watermark)

Definition at line 352 of file IPCQueueStub.cpp.

◆ getMsgSize()

NATIVE_INT_TYPE Os::IPCQueue::getMsgSize ( ) const

get the message size (maximum message size queue can hold)

Definition at line 370 of file IPCQueueStub.cpp.

◆ getNumMsgs()

NATIVE_INT_TYPE Os::IPCQueue::getNumMsgs ( ) const

get the number of messages in the queue

Definition at line 343 of file IPCQueueStub.cpp.

◆ getQueueSize()

NATIVE_INT_TYPE Os::IPCQueue::getQueueSize ( ) const

get the queue depth (maximum number of messages queue can hold)

Definition at line 361 of file IPCQueueStub.cpp.

◆ receive() [1/2]

Queue::QueueStatus Os::IPCQueue::receive	(	Fw::SerializeBufferBase &	buffer,
		NATIVE_INT_TYPE &	priority,
		QueueBlocking	block
	)

receive a message

Definition at line 15 of file IPCQueueCommon.cpp.

◆ receive() [2/2]

Queue::QueueStatus Os::IPCQueue::receive	(	U8 *	buffer,
		NATIVE_INT_TYPE	capacity,
		NATIVE_INT_TYPE &	actualSize,
		NATIVE_INT_TYPE &	priority,
		QueueBlocking	block
	)

receive a message

Definition at line 318 of file IPCQueueStub.cpp.

◆ send() [1/2]

Queue::QueueStatus Os::IPCQueue::send	(	const Fw::SerializeBufferBase &	buffer,
		NATIVE_INT_TYPE	priority,
		QueueBlocking	block
	)

send a message

Definition at line 6 of file IPCQueueCommon.cpp.

◆ send() [2/2]

Queue::QueueStatus Os::IPCQueue::send	(	const U8 *	buffer,
		NATIVE_INT_TYPE	size,
		NATIVE_INT_TYPE	priority,
		QueueBlocking	block
	)