Navigation
API > API/Plugins > API/Plugins/ElectraBase > API/Plugins/ElectraBase/Core
References
| Module | ElectraBase |
| Header | /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Core/MediaMessageQueue.h |
| Include | #include "Core/MediaMessageQueue.h" |
Syntax
template<typename T>
class TMediaMessageQueueDynamicWithTimeout
Remarks
Generic message queue WITH timeout support.
Conceptually a message queue is a multiple-sender, single-receiver object, so use it only in that way!
This version supports an unlimited number of messages (we limit it to 2^31-1) Sending a message can therefore never block. We keep the interface identical to TMediaMessageQueueNoTimeout::SendMessage for compatibility.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
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. |
 |
bool | ReceiveMessage
(
T& Message, |
Waits a maximum amount of time for a message to arrive. |
 |
bool | SendMessage
(
const T& Message, |
Sends a message. |