UStormSyncTransportSettings

API > API/Plugins > API/Plugins/StormSyncTransportCore

Settings for the StormSyncTransport plugins.

Handles config for transport / network related features.


Name	UStormSyncTransportSettings
Type	class
Header File	/Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncTransportCore/Public/StormSyncTransportSettings.h
Include Path	#include "StormSyncTransportSettings.h"

Syntax

UCLASS (Config=Game, defaultconfig, DisplayName="Transport & Network")  
class UStormSyncTransportSettings : public UDeveloperSettings

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UStormSyncTransportSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UStormSyncTransportSettings()		StormSyncTransportSettings.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bAutoStartServer	bool	Should this editor instance starts on startup a Storm Sync server endpoint (messaging and tcp)	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
bEnableDiscoveryPeriodicPublish	bool	Whether to allow Discovery Manager to broadcast a connect message at periodic interval (period time being the value of MessageBusTimeBeforeRemovingInactiveSource).	StormSyncTransportSettings.h	Config EditAnywhere AdvancedDisplay Category="Service Discovery" Meta=(ConfigRestartRequired=true)
bOverrideServerAddress	bool	Whether to use a custom listen hostname address for the TCP server.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
bShowImportWizard	bool	When set to true, an import wizard will be prompted to the user upon receiving a buffer request from network	StormSyncTransportSettings.h	Config EditAnywhere Category="UI"
bTcpDryRun	bool	Debug Development config.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
ConnectionRetryDelay	uint32	Delay time between attempts to re-establish outgoing connections that become disconnected or fail to connect	StormSyncTransportSettings.h	Config EditAnywhere Category="Client"
DiscoveryManagerTickInterval	float	How long we should wait before checking for message bus sources activity	StormSyncTransportSettings.h	Config EditAnywhere AdvancedDisplay Category="Service Discovery" Meta=(ClampMin="0.1", ConfigRestartRequired=true, ForceUnits=s)
FStormSyncTransportSettingsDetailsCustomization	friend	For TcpServerAddress customization as ip dropdown	StormSyncTransportSettings.h
InactiveTimeoutSeconds	uint32	The amount of time in seconds to consider a client to be inactive, if it has not sent data in this interval.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
MessageBusHeartbeatPeriod	float	The refresh frequency of the heartbeat event	StormSyncTransportSettings.h	Config EditAnywhere AdvancedDisplay Category="Service Discovery" Meta=(ClampMin="0.1", ConfigRestartRequired=true, ForceUnits=s)
MessageBusHeartbeatTimeout	double	How long we should wait before a connected device becomes unresponsive	StormSyncTransportSettings.h	Config EditAnywhere AdvancedDisplay Category="Service Discovery" Meta=(ClampMin="0.1", ConfigRestartRequired=true, ForceUnits=s)
MessageBusTimeBeforeRemovingInactiveSource	double	Subjects will be removed when their source has been unresponsive for this long	StormSyncTransportSettings.h	Config EditAnywhere AdvancedDisplay Category="Service Discovery" Meta=(ClampMin="0.1", ConfigRestartRequired=true, ForceUnits=s)
ServerName	FString	User friendly name to describe this server on the network (defaults to hostname if left to empty)	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
TcpServerAddress	FString	The IP endpoint to listen to when starting off the tcp socket server listener.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server" Meta=(EditCondition="bOverrideServerAddress", EditConditionHides)
TcpServerPort	uint16	The port to listen on when starting off the tcp socket server listener.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"
TcpServerPortMaxOffset	uint16	Specifies the port offset range when trying to acquire an available socket for the Tcp server.	StormSyncTransportSettings.h	Config EditAnywhere Category="Server"

Functions

Public

Name	Remarks	Include Path
uint32 GetConnectionRetryDelay()	Returns connection delay	StormSyncTransportSettings.h
float GetDiscoveryManagerTickInterval()	Returns message bus heartbeat frequency in seconds, tick interval for the discovery manager to check for heartbeats timeouts	StormSyncTransportSettings.h
uint32 GetInactiveTimeoutSeconds()	Returns inactive timeout period. The amount of time in seconds to consider a client to be inactive	StormSyncTransportSettings.h
float GetMessageBusHeartbeatPeriod()	Returns message bus heartbeat frequency in seconds	StormSyncTransportSettings.h
double GetMessageBusHeartbeatTimeout()	Returns message bus heartbeat timeout in seconds, to determine when a connected device becomes unresponsive	StormSyncTransportSettings.h
double GetMessageBusTimeBeforeRemovingInactiveSource()	Returns message bus inactive timeout in seconds, to determine when a connected device is considered disconnected	StormSyncTransportSettings.h
FString GetServerEndpoint ()	Gets the listen endpoint endpoint to listen to when starting off the tcp socket server listener.	StormSyncTransportSettings.h
FString GetServerName()	Returns user friendly name to describe this server on the network (defaults to hostname if left to empty)	StormSyncTransportSettings.h
FString GetTcpServerAddress()	Returns the hostname tcp server is configured to run on	StormSyncTransportSettings.h
uint16 GetTcpServerPort()	Returns the port tcp server is configured to run on	StormSyncTransportSettings.h
uint16 GetTcpServerPortMaxOffset()	Returns th port offset range when trying to acquire an available socket for the Tcp server.	StormSyncTransportSettings.h
bool HasConnectionRetryDelay()	Returns connection delay	StormSyncTransportSettings.h
bool IsAutoStartServer()	Whether we should start the server endpoint on startup	StormSyncTransportSettings.h
bool IsDiscoveryPeriodicPublishEnabled()	Returns whether discovery manager should send a connect message at a regular interval (broadcast / publish)	StormSyncTransportSettings.h
bool IsTcpDryRun()	Returns true if we are in debug mode dry mode and shouldn't extract incoming buffer to local project	StormSyncTransportSettings.h
void OpenEditorSettingsWindow()	Helper to bring focus on transport settings in editor	StormSyncTransportSettings.h
bool ShouldShowImportWizard()	Returns true if we are in debug mode dry mode and shouldn't extract incoming buffer to local project	StormSyncTransportSettings.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static const UStormSyncTransportSettings & Get()		StormSyncTransportSettings.h

Can't find any content

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Protected

Functions

Public

Static