1. Epic GamesDeveloper
  3. IServerProxy

IServerProxy

Interface for internal networking implementation.

API > API/Plugins > API/Plugins/OSC

Inheritance Hierarchy

References

   
Module OSC
Header /Engine/Plugins/Runtime/OSC/Source/OSC/Public/OSCServer.h
Include #include "OSCServer.h"

Syntax

class IServerProxy

Remarks

Interface for internal networking implementation. See UOSCServer for details

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddClientEndpointToAllowList ( const FIPv4Endpoint& InIPv4Endpoint
)

 Adds the given endpoint to the client allow list.
Public function Virtual void

AddClientToAllowList ( const FString& InIPAddress
)

  
Public function Const bool

CanProcessPacket ( TSharedRef< UE::OSC::IPacket > Packet
)

 Returns whether or not packet can be processed, i.e. is valid and allowlisted.
Public function Virtual void  
Public function void Empties the given address to the client allow list.
Public function 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.
Public function Virtual Const TSet< FString >  
Public function Const const TSet< FIPv4Endpoint > & Returns Client Address allow list if it is enabled, else returns nullptr.
Public function Const FString Returns debug description of server proxy.
Public function Virtual Const FString  
Public function Const const FIPv4Endpoint &  
Public function Const bool Returns whether or not loopback is enabled.
Public function Virtual Const int32

GetPort ()

  
Public function Const bool Returns whether or not the server is currently active (listening)
Public function void

Listen ( const FString& ServerName
)

 Starts the server, causing it to actively listen and dispatch OSC messages.
Public function void

RemoveClientEndpointFromAllowList ( const FIPv4Endpoint& InIPv4Endpoint
)

 Removes the given endpoint from the client allow list.
Public function Virtual void

RemoveClientFromAllowList ( const FString& IPAddress
)

  
Public function Virtual bool

SetAddress ( const FString& InReceiveIPAddress,
int32 InPort
)

  
Public function void

SetFilterClientsByAllowList ( bool bEnabled
)

 Sets whether or not allow list is active.
Public function bool

SetIPEndpoint ( const FIPv4Endpoint& InEndpoint
)

 Sets the current server's endpoint.
Public function bool

SetMulticastLoopback ( bool bInMulticastLoopback
)

 Sets whether or not loopback is enabled.
Public function 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)
Public function Virtual void

SetTickableInEditor ( bool bInTickInEditor
)

  
Public function void

Stop ()

 Stops the server.

Typedefs

Name Description
FOnDispatchPacket  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page