TMediaMessageQueueWithTimeout

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 only a maximum number of messages that needs to be specified in the constructor or by calling Resize() before first use.


Name	TMediaMessageQueueWithTimeout
Type	class
Header File	/Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/Core/MediaMessageQueue.h
Include Path	#include "Core/MediaMessageQueue.h"

Syntax

template<typename T>  
class TMediaMessageQueueWithTimeout

Name	Remarks	Include Path	Unreal Specifiers
TMediaMessageQueueWithTimeout ( SIZE_T MaxMessages )	Constructor.	Core/MediaMessageQueue.h

Name	Type	Include Path
AvailSema	FMediaSemaphore	Core/MediaMessageQueue.h
Messages	TMediaQueue< T, FMediaLockCriticalSection >	Core/MediaMessageQueue.h
ReadySema	FMediaSemaphore	Core/MediaMessageQueue.h

Name	Remarks	Include Path
bool HaveMessage()	Checks if there are pending messages.	Core/MediaMessageQueue.h
bool JamMessage ( const T& Message, bool bWaitIfFull )	Jams a message to the front of the queue.	Core/MediaMessageQueue.h
SIZE_T NumWaitingMessages()	Queries the number of messages in the queue.	Core/MediaMessageQueue.h
T ReceiveMessage ()	Waits indefinitely for a message to arrive.	Core/MediaMessageQueue.h
bool ReceiveMessage ( T& Message )	Receives a message if one is already pending in the queue.	Core/MediaMessageQueue.h
bool ReceiveMessage ( T& Message, int64 MaxWaitMicroseconds )	Waits a maximum amount of time for a message to arrive.	Core/MediaMessageQueue.h
void Resize ( SIZE_T MaxMessages )	Resizes the message queue, discarding any messages it may hold.	Core/MediaMessageQueue.h
bool SendMessage ( const T& Message, bool bWaitIfFull )	Sends a message.	Core/MediaMessageQueue.h