Navigation
API > API/Plugins > API/Plugins/ElectraBase > API/Plugins/ElectraBase/Core
Inheritance Hierarchy
- TMediaMessageQueueNoTimeout
- TMediaMessageQueueStaticNoTimeout
References
| Module | ElectraBase |
| Header | /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Core/MediaMessageQueue.h |
| Include | #include "Core/MediaMessageQueue.h" |
Syntax
template<typename T>
class TMediaMessageQueueNoTimeout
Remarks
Generic message queue WITHOUT timeout support.
Conceptually a message queue is a multiple-sender, single-receiver object, so use it only in that way!
This version supports only a maximum number of messages that needs to be specified in the constructor or by calling Resize() before first use.
Constructors
| Type | Name | Description | |
|---|---|---|---|
TMediaMessageQueueNoTimeout
(
SIZE_T MaxMessages |
Constructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | HaveMessage () |
Checks if there are pending messages. | |
| bool | JamMessage
(
const T& Message, |
Jams a message to the front of the queue. | |
| SIZE_T | Queries the number of messages in the queue. | ||
| T | Waits indefinitely for a message to arrive. | ||
| bool | ReceiveMessage
(
T& Message |
Receives a message if one is already pending in the queue. | |
| void | Resizes the message queue, discarding any messages it may hold. | ||
| bool | SendMessage
(
const T& Message, |
Sends a message. |