Navigation
API > API/Plugins > API/Plugins/StormSyncTransportServer
| Name | IStormSyncTransportServerModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncTransportServer/Public/IStormSyncTransportServerModule.h |
| Include Path | #include "IStormSyncTransportServerModule.h" |
Syntax
class IStormSyncTransportServerModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IStormSyncTransportServerLocalEndpoint > CreateServerLocalEndpoint
(
const FString& InEndpointFriendlyName |
Creates a local transport endpoint. Should be used for tests only. | IStormSyncTransportServerModule.h | |
FString GetDiscoveryManagerMessageAddressId() |
Returns Message Address UID for discovery manager endpoint | IStormSyncTransportServerModule.h | |
FStormSyncHeartbeatEmitter & GetHeartbeatEmitter() |
Returns implementation of StormSync Heartbeat Emitter runnable | IStormSyncTransportServerModule.h | |
FString GetServerEndpointMessageAddressId() |
Returns Message Address UID for server endpoint if it is currently running, empty string otherwise | IStormSyncTransportServerModule.h | |
bool GetServerStatus
(
FText& OutStatusText |
Returns whether Storm Sync Server endpoint is currently active and running, along with a status text indicating current status and endpoint addresses (message bus and tcp server) | IStormSyncTransportServerModule.h | |
bool IsRunning() |
Returns whether Storm Sync Server endpoint is currently active and running | IStormSyncTransportServerModule.h | |
void StartDiscoveryManager () |
Starts the discovery manager. | IStormSyncTransportServerModule.h | |
void StartServerEndpoint
(
const FString& InEndpointFriendlyName |
Starts a local transport endpoint. This will automatically start the discovery manager. | IStormSyncTransportServerModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IStormSyncTransportServerModule & Get () |
Singleton-like access to this module's interface. | IStormSyncTransportServerModule.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IStormSyncTransportServerModule.h |