DirectLink Namespace Reference

Namespaces
namespace	Internal

Classes
struct	FCommunicationStatus
class	FDeltaReceiver
class	FElementSnapshot
class	FEndpoint
class	FHaveListReceiver
class	FInternalThreadState
class	FParameterStore
class	FParameterStoreSnapshot
class	FPipeBase
struct	FRawInfo
struct	FReferenceSnapshot
class	FRemoteSceneView
class	FSceneGraphSharedState
struct	FSceneIdentifier
class	FScenePipeFromNetwork
class	FScenePipeToNetwork
class	FSceneSnapshot
class	FSharedState
class	FSnapshotProxy
class	FStreamConnectionPoint
struct	FStreamDescription
class	FStreamDestination
class	FStreamReceiver
class	FStreamSender
class	FStreamSource
struct	FTempBacktrack
class	IConnectionRequestHandler
class	IDeltaConsumer
class	IDeltaProducer
class	IEndpointObserver
class	IReferenceProxy
class	IReferenceResolutionProvider
class	ISceneGraphNode
class	ISceneReceiver
class	IStreamCommunicationInterface
class	IStreamReceiver
class	IStreamSender
class	TStoreKey

Typedefs
using	FSceneGraphId = uint32
using	FElementHash = uint32
using	FStreamPort = uint32
using	FSourceHandle = FGuid
using	FDestinationHandle = FGuid

Enumerations
enum class	EVisibility { Public , Private }
enum class	EStreamConnectionState { Uninitialized , RequestSent , Active , Closed }
enum class	ESerializationStatus { Ok , StreamError , VersionMinNotRespected , VersionMaxNotRespected }
enum class	ECommunicationStatus { NoIssue = 0 , ModuleNotLoaded_Messaging = 1<<0 , ModuleNotLoaded_UdpMessaging = 1<<1 , ModuleNotLoaded_Networking = 1<<2 }

Functions
ECommunicationStatus	ValidateCommunicationStatus ()
FRawInfo::FEndpointInfo	FromMsg (const FDirectLinkMsg_EndpointState &Msg)
uint8	GetCurrentProtocolVersion ()
uint8	GetMinSupportedProtocolVersion ()
const FString &	GetDumpPath ()
void	DumpSceneSnapshot (FSceneSnapshot &SceneSnapshot, const FString &BaseFileName)
FArchive &	operator<< (FArchive &Ar, FSceneIdentifier &SceneId)
FArchive &	operator<< (FArchive &Ar, IDeltaConsumer::FSetupSceneArg &SetupSceneArg)
FArchive &	operator<< (FArchive &Ar, IDeltaConsumer::FOpenDeltaArg &OpenDeltaArg)
FArchive &	operator<< (FArchive &Ar, IDeltaConsumer::FCloseDeltaArg &CloseDeltaArg)
void	RecursiveAddElements (TSet< ISceneGraphNode * > &Nodes, ISceneGraphNode *Element)
TSet< ISceneGraphNode * >	BuildIndexForScene (ISceneGraphNode *RootElement)
TSharedPtr< FSceneSnapshot >	SnapshotScene (ISceneGraphNode *RootElement)

Variables
struct {
double   DirectLink::HeartbeatThreshold_s = 5.0
bool   DirectLink::bPeriodicalyCleanupTimedOutEndpoint = true
double   DirectLink::ThresholdEndpointCleanup_s = 30.0
double   DirectLink::CleanupOldEndpointPeriod_s = 10.0
bool   DirectLink::bAutoconnectFromSources = true
bool   DirectLink::bAutoconnectFromDestination = false
}	gConfig
double	gUdpMessagingInitializationTime = -1.
constexpr FSceneGraphId	InvalidId = 0
constexpr FElementHash	InvalidHash = 0
constexpr FStreamPort	InvalidStreamPort = 0

Typedef Documentation

FDestinationHandle

using DirectLink::FDestinationHandle = typedef FGuid

FElementHash

using DirectLink::FElementHash = typedef uint32

FSceneGraphId

using DirectLink::FSceneGraphId = typedef uint32

Node Id, aka Element Id. Represent a node within a scene. As a scene has a guid, the combination guid/id must be globally unique.

FSourceHandle

using DirectLink::FSourceHandle = typedef FGuid

FStreamPort

using DirectLink::FStreamPort = typedef uint32

Enumeration Type Documentation

ECommunicationStatus

enum class DirectLink::ECommunicationStatus

strong

Enumerator
NoIssue
ModuleNotLoaded_Messaging
ModuleNotLoaded_UdpMessaging
ModuleNotLoaded_Networking

ESerializationStatus

enum class DirectLink::ESerializationStatus

strong

Enumerator
Ok
StreamError
VersionMinNotRespected
VersionMaxNotRespected

EStreamConnectionState

enum class DirectLink::EStreamConnectionState

strong

Enumerator
Uninitialized
RequestSent
Active
Closed

EVisibility

enum class DirectLink::EVisibility

strong

Used by data source and destination to describe how they are discovered by remote endpoints

Enumerator
Public
Private

Function Documentation

BuildIndexForScene()

TSet< ISceneGraphNode * > DIRECTLINK_API DirectLink::BuildIndexForScene

(

ISceneGraphNode *

RootElement

)

DumpSceneSnapshot()

DIRECTLINK_API void DirectLink::DumpSceneSnapshot	(	FSceneSnapshot &	SceneSnapshot,
		const FString &	BaseFileName
	)

FromMsg()

FRawInfo::FEndpointInfo DirectLink::FromMsg

(

const FDirectLinkMsg_EndpointState &

Msg

)

GetCurrentProtocolVersion()

uint8 DirectLink::GetCurrentProtocolVersion

(

)

GetDumpPath()

DIRECTLINK_API const FString & DirectLink::GetDumpPath

(

)

GetMinSupportedProtocolVersion()

uint8 DirectLink::GetMinSupportedProtocolVersion

(

)

operator<<() [1/4]

FArchive & DirectLink::operator<<	(	FArchive &	Ar,
		FSceneIdentifier &	SceneId
	)

operator<<() [2/4]

FArchive & DirectLink::operator<<	(	FArchive &	Ar,
		IDeltaConsumer::FCloseDeltaArg &	CloseDeltaArg
	)

operator<<() [3/4]

FArchive & DirectLink::operator<<	(	FArchive &	Ar,
		IDeltaConsumer::FOpenDeltaArg &	OpenDeltaArg
	)

operator<<() [4/4]

FArchive & DirectLink::operator<<	(	FArchive &	Ar,
		IDeltaConsumer::FSetupSceneArg &	SetupSceneArg
	)

RecursiveAddElements()

void DirectLink::RecursiveAddElements	(	TSet< ISceneGraphNode * > &	Nodes,
		ISceneGraphNode *	Element
	)

SnapshotScene()

TSharedPtr< FSceneSnapshot > DIRECTLINK_API DirectLink::SnapshotScene

(

ISceneGraphNode *

RootElement

)

ValidateCommunicationStatus()

DIRECTLINK_API ECommunicationStatus DirectLink::ValidateCommunicationStatus

(

)

Variable Documentation

bAutoconnectFromDestination

bool DirectLink::bAutoconnectFromDestination = false

bAutoconnectFromSources

bool DirectLink::bAutoconnectFromSources = true

bPeriodicalyCleanupTimedOutEndpoint

bool DirectLink::bPeriodicalyCleanupTimedOutEndpoint = true

CleanupOldEndpointPeriod_s

double DirectLink::CleanupOldEndpointPeriod_s = 10.0

[struct]

struct { ... } DirectLink::gConfig

gUdpMessagingInitializationTime

double DirectLink::gUdpMessagingInitializationTime = -1.

HeartbeatThreshold_s

double DirectLink::HeartbeatThreshold_s = 5.0

InvalidHash

constexpr FElementHash DirectLink::InvalidHash = 0

constexpr

InvalidId

constexpr FSceneGraphId DirectLink::InvalidId = 0

constexpr

InvalidStreamPort

constexpr FStreamPort DirectLink::InvalidStreamPort = 0

constexpr

ThresholdEndpointCleanup_s

double DirectLink::ThresholdEndpointCleanup_s = 30.0