Navigation
| Name | StormSyncTransportCore |
| Type | Plugin |
| Part of Plugins | Storm Sync |
| Location | /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncTransportCore/ |
| Module Build Rules | StormSyncTransportCore.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FStormSyncTransportNetworkUtils | Network related helpers |
| UStormSyncTransportSettings | Settings for the StormSyncTransport plugins. |
Structs
| Name | Remarks |
|---|---|
| FStormSyncConnectionInfo | Holds data about local project (such as Message Address Ids, Project Name, Hostname, InstanceId, etc.) |
| FStormSyncTransportConnectMessage | Connection message indicating a Connect event with data about local project / application |
| FStormSyncTransportHeartbeatMessage | Empty message indicating an Heartbeat event |
| FStormSyncTransportPingMessage | Basic Ping message |
| FStormSyncTransportPongMessage | Basic Pong message (which is effectively a Ping without extra info) |
| FStormSyncTransportPullRequest | Pull Request message (which is effectively a SyncRequest with extra info about local server and network config) |
| FStormSyncTransportPullResponse | FStormSyncTransportPullResponse, a FStormSyncTransportSyncResponse child struct. |
| FStormSyncTransportPushRequest | Push Request message (which is effectively a SyncRequest without extra info) |
| FStormSyncTransportPushResponse | FStormSyncTransportPushResponse, a FStormSyncTransportSyncResponse child struct. |
| FStormSyncTransportStatusPing | |
| FStormSyncTransportStatusPong | |
| FStormSyncTransportStatusRequest | |
| FStormSyncTransportStatusResponse | |
| FStormSyncTransportSyncRequest | FStormSyncTransportSyncRequest. |
| FStormSyncTransportSyncResponse | FStormSyncTransportSyncResponse. |
| FStormSyncTransportTcpPacket | |
| FStormSyncTransportTcpSizePacket | This is a socket "message" sent from receiver to notify sender of the amount of bytes received so far |
| FStormSyncTransportTcpStatePacket | This is an initial snapshot, sent upon connecting |
| FStormSyncTransportTcpTransferCompletePacket | This is a socket "message" sent from receiver to notify sender of the amount of bytes received so far |
| FStormSyncTransportWakeupRequest | Request sent by the discovery service to wake up the other endpoints in case they become inactive. |
Interfaces
| Name | Remarks |
|---|---|
| IStormSyncTransportLocalEndpoint | Interface representing a local endpoint you can send from for Storm Sync |
| IStormSyncTransportMessageService | Interface for message services |
Enums
Public
| Name | Remarks |
|---|---|
| EStormSyncResponseResult |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| UE::StormSync::Transport::Private::NoServerAutoStartFlag | const TCHAR * | Utils/StormSyncTransportCommandUtils.h | |
| UE::StormSync::Transport::Private::ServerEndpointFlag | const TCHAR * | Utils/StormSyncTransportCommandUtils.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool UE::StormSync::Transport::Private::GetServerEndpointParam
(
FString& OutEndpointValue, |
Returns value of command line -StormSyncServerEndpoint=hostname:1234 flag. | Utils/StormSyncTransportCommandUtils.h | |
bool UE::StormSync::Transport::Private::IsServerAutoStartDisabled() |
Returns whether command line has either -StormSyncServerAutoStart or a valid -StormSyncServerEndpoint= |
Utils/StormSyncTransportCommandUtils.h |