Navigation
API > API/Plugins > API/Plugins/OSC
Interface for internal networking implementation. See UOSCServer for details
| Name | IServerProxy |
| Type | class |
| Header File | /Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCServer.h |
| Include Path | #include "OSCServer.h" |
Syntax
class IServerProxy
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IServerProxy() |
OSCServer.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnDispatchPacket | TUniqueFunction< void(TSharedRef< UE::OSC::IPacket >)> | OSCServer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddClientEndpointToAllowList
(
const FIPv4Endpoint& InIPv4Endpoint |
Adds the given endpoint to the client allow list. | OSCServer.h | |
virtual void AddClientToAllowList
(
const FString& InIPAddress |
OSCServer.h | ||
bool CanProcessPacket
(
TSharedRef< UE::OSC::IPacket > Packet |
Returns whether or not packet can be processed, i.e. is valid and allowlisted. | OSCServer.h | |
virtual void ClearClientAllowList() |
OSCServer.h | ||
void ClearClientEndpointAllowList() |
Empties the given address to the client allow list. | OSCServer.h | |
virtual TSet< FString > GetClientAllowList() |
OSCServer.h | ||
const TSet< FIPv4Endpoint > & GetClientEndpointAllowList() |
Returns Client Address allow list if it is enabled, else returns nullptr. | OSCServer.h | |
FString GetDescription() |
Returns debug description of server proxy. | OSCServer.h | |
virtual FString GetIpAddress() |
OSCServer.h | ||
const FIPv4Endpoint & GetIPEndpoint() |
OSCServer.h | ||
bool GetMulticastLoopback() |
Returns whether or not loopback is enabled. | OSCServer.h | |
virtual int32 GetPort() |
OSCServer.h | ||
bool IsActive() |
Returns whether or not the server is currently active (listening) | OSCServer.h | |
void Listen
(
const FString& ServerName |
Starts the server, causing it to actively listen and dispatch OSC messages. | OSCServer.h | |
void RemoveClientEndpointFromAllowList
(
const FIPv4Endpoint& InIPv4Endpoint |
Removes the given endpoint from the client allow list. | OSCServer.h | |
virtual void RemoveClientFromAllowList
(
const FString& IPAddress |
OSCServer.h | ||
virtual bool SetAddress
(
const FString& InReceiveIPAddress, |
OSCServer.h | ||
void SetFilterClientsByAllowList
(
bool bEnabled |
Sets whether or not allow list is active. | OSCServer.h | |
bool SetIPEndpoint
(
const FIPv4Endpoint& InEndpoint |
Sets the current server's endpoint. | OSCServer.h | |
bool SetMulticastLoopback
(
bool bInMulticastLoopback |
Sets whether or not loopback is enabled. | OSCServer.h | |
virtual void SetOnDispatchPacket
(
TSharedPtr< FOnDispatchPacket > OnDispatch |
Sets dispatch function to be called when OSC packet is received (thread safe and can be mutated while server is running) | OSCServer.h | |
virtual void SetTickableInEditor
(
bool bInTickInEditor |
OSCServer.h | ||
void Stop() |
Stops the server. | OSCServer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< IServerProxy > Create() |
Creates a new server proxy that can be used by any system where the provided dispatch callback is called on a worker thread. | OSCServer.h |