Navigation
API > API/Plugins > API/Plugins/BackChannel
A class that wraps an existing BackChannel connection and provides an OSC-focused interface and a background thread. Incoming messages are received on a background thread and queued until DispatchMessages() is called. Outgoing messages are sent immediately
| Name | FBackChannelOSCConnection |
| Type | class |
| Header File | /Engine/Plugins/Experimental/BackChannel/Source/BackChannel/Public/BackChannel/Protocol/OSC/BackChannelOSCConnection.h |
| Include Path | #include "BackChannel/Protocol/OSC/BackChannelOSCConnection.h" |
Syntax
class FBackChannelOSCConnection :
private FRunnable,
public IBackChannelConnection
Inheritance Hierarchy
- FRunnable → FBackChannelOSCConnection
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBackChannelOSCConnection
(
TSharedRef< IBackChannelSocketConnection > InConnection |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FBackChannelOSCConnection() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetDescription() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
bool IsConnected() |
Returns our connection state as determined by the underlying BackChannel connection | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
bool IsThreaded() |
Returns true if running in the background | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
void ReceiveAndDispatchMessages
(
const float MaxTime |
Checks for and dispatches any incoming messages. | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
bool SendPacket
(
FBackChannelOSCPacket& Packet |
Send the provided OSC packet | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
void SetMessageOptions
(
const TCHAR* Path, |
Set options for the specified message path | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
bool StartReceiveThread() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
virtual void Stop() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h |
Overridden from IBackChannelConnection
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDelegateHandle AddRouteDelegate
(
FStringView Path, |
Bind a delegate to a message address | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
virtual TBackChannelSharedPtr< IBackChannelPacket > CreatePacket() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
virtual FString GetProtocolName() |
IBackChannelConnection implementation | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
virtual void RemoveRouteDelegate
(
FStringView Path, |
Remove a delegate handle | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
virtual int SendPacket
(
const TBackChannelSharedPtr< IBackChannelPacket >& Packet |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
virtual void SetBufferSizes
(
int32 DesiredSendSize, |
Sets the send and receive buffer sizes | BackChannel/Protocol/OSC/BackChannelOSCConnection.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DispatchMessages() |
Dispatch all queued messages | BackChannel/Protocol/OSC/BackChannelOSCConnection.h | |
int32 GetMessageCountForPath
(
const TCHAR* Path |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
int32 GetMessageLimitForPath
(
const TCHAR* Path |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
void ReceiveMessages
(
const float MaxTime |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
void RemoveMessagesWithPath
(
const TCHAR* Path, |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
virtual uint32 Run() |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h | ||
bool SendPacketData
(
const void* Data, |
BackChannel/Protocol/OSC/BackChannelOSCConnection.h |