Navigation
API > API/Plugins > API/Plugins/DMXProtocol
Listen to all DMX data of a port.
Thread-safe single producer single consumer: Single producer always is the DMX port. This is handled by the port internally. Do not use EnqueueSignal somewhere else to retain thread-safety. Single consumer is the user thread.
Needs frequent dequeuing. Stop needs to be called before the Input is released.
| Name | FDMXRawListener |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXRawListener.h |
| Include Path | #include "IO/DMXRawListener.h" |
Syntax
class FDMXRawListener : public TSharedFromThis< FDMXRawListener >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDMXRawListener
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| IO/DMXRawListener.h | |||
FDMXRawListener
(
TSharedRef< FDMXPort, ESPMode::ThreadSafe > InOwnerPort |
Constructor | IO/DMXRawListener.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDMXRawListener() |
Destructor | IO/DMXRawListener.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bStopped | bool | True when stopped | IO/DMXRawListener.h | |
| ExternUniverseOffset | TAtomic< int32 > | The extern universe offset of the port | IO/DMXRawListener.h | |
| OwnerPort | TWeakPtr< FDMXPort, ESPMode::ThreadSafe > | The port that owns this Listener | IO/DMXRawListener.h | |
| RawBuffer | TQueue< FDMXSignalSharedPtr, EQueueMode::Spsc > | The actual buffer | IO/DMXRawListener.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearBuffer() |
Thread-safe. Clears the raw buffer | IO/DMXRawListener.h | |
bool DequeueSignal
(
void* Consumer, |
Thread safe single consumer. Tries to dequeues a signal from the raw listener. | IO/DMXRawListener.h | |
virtual void EnqueueSignal
(
void* Producer, |
Thread safe single producer. | IO/DMXRawListener.h | |
void Start() |
Starts receiving the Input | IO/DMXRawListener.h | |
void Stop() |
Stops receiving the Input | IO/DMXRawListener.h |