Navigation
API > API/Plugins > API/Plugins/StormSyncTransportServer
Inheritance Hierarchy
- IModuleInterface
- IStormSyncTransportServerModule
References
| Module | StormSyncTransportServer |
| Header | /Engine/Plugins/Experimental/StormSync/Source/StormSyncTransportServer/Public/IStormSyncTransportServerModule.h |
| Include | #include "IStormSyncTransportServerModule.h" |
Syntax
class IStormSyncTransportServerModule : public IModuleInterface
Functions
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< IStormSyncTransportServerLocalEndpoint > | CreateServerLocalEndpoint
(
const FString& InEndpointFriendlyName |
Creates a local transport endpoint. Should be used for tests only. | |
| IStormSyncTransportServerModule & | Get () |
Singleton-like access to this module's interface. | |
| FString | Returns Message Address UID for discovery manager endpoint | ||
| FStormSyncHeartbeatEmitter & | Returns implementation of StormSync Heartbeat Emitter runnable | ||
| FString | Returns Message Address UID for server endpoint if it is currently running, empty string otherwise | ||
| 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) | |
| bool | IsAvailable () |
Checks to see if this module is loaded and ready. | |
| bool | IsRunning () |
Returns whether Storm Sync Server endpoint is currently active and running | |
| void | Starts the discovery manager. | ||
| void | StartServerEndpoint
(
const FString& InEndpointFriendlyName |
Starts a local transport endpoint. This will automatically start the discovery manager. |