API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrNetSyncConnection Struct

It represents the connection of a network synchronization system that allows multiple clients to connect and communicate with each other in real-time. It provides a way to manage and facilitate real-time communication and data synchronization between multiple clients in a networked environment.

Constructors

FOvrNetSyncConnection ()
This is the default constructor for the struct, which initializes the ::ovrNetSyncConnectionHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrNetSyncConnection::FOvrNetSyncConnection()
FOvrNetSyncConnection ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrNetSyncConnection::FOvrNetSyncConnection(ovrNetSyncConnectionHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrNetSyncConnectionHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

ConnectionId : int64
A 'long' integer ID which can be used to uniquely identify the network synchronization connection.
Signature
int64 FOvrNetSyncConnection::ConnectionId
DisconnectReason : EOvrNetSyncDisconnectReason
If the status is EOvrNetSyncConnectionStatus::Disconnected, EOvrNetSyncDisconnectReason specifies the reason. EOvrNetSyncDisconnectReason::Unknown - The disconnect reason was unknown. EOvrNetSyncDisconnectReason::LocalTerminated - The disconnect was requested by an user. EOvrNetSyncDisconnectReason::ServerTerminated - The server closed the connection. EOvrNetSyncDisconnectReason::Failed - The initial connection never succeeded. EOvrNetSyncDisconnectReason::Lost - The disconnect was caused by network timeout.
Signature
EOvrNetSyncDisconnectReason FOvrNetSyncConnection::DisconnectReason
SessionId : FOvrId
The ID of the local session. Will be null if the connection is not active.
Signature
FOvrId FOvrNetSyncConnection::SessionId
A EOvrNetSyncConnectionStatus that defines the different status of the network synchronization connection. EOvrNetSyncConnectionStatus::Unknown - The current connection status is unknown. EOvrNetSyncConnectionStatus::Connecting - The connection has been started and the process is ongoing. EOvrNetSyncConnectionStatus::Disconnected - The current connection status is disconnected. EOvrNetSyncConnectionStatus::Connected - The connection has been established.
Signature
EOvrNetSyncConnectionStatus FOvrNetSyncConnection::Status
ZoneId : FString
A string represents the unique identifier within the current application grouping.
Signature
FString FOvrNetSyncConnection::ZoneId

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrNetSyncConnection::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrNetSyncConnection::Update(ovrNetSyncConnectionHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrNetSyncConnectionHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void