Connector

instant3Dhub

Topics | Classes | Functions | Variables

Connector

Detailed Description

The connector is the central actor of the Unreal Plugin and manages the connection with the instant3Dhub.

Topics
	Disconnect

Classes
struct	FI3DHConnectOptions
class	AI3DHConnector

Functions
void	AI3DHConnector::AddNetworkCredentialCookie (const FString &CookieKey, const FString &CookieValue)
void	AI3DHConnector::RemoveNetworkCredentialCookie (const FString &CookieKey)
void	AI3DHConnector::AddNetworkCredentialToken (const FString &TokenKey, const FString &TokenValue)
void	AI3DHConnector::RemoveNetworkCredentialToken (const FString &TokenKey)
const TMap< FString, FString > &	AI3DHConnector::GetNetworkCredentialCookies () const
const TMap< FString, FString > &	AI3DHConnector::GetNetworkCredentialTokens () const
void	AI3DHConnector::ConnectToHub (const FString &HubURL, const FString &SessionId)
void	AI3DHConnector::ConnectToHubWithOptions (const FString &HubURL, const FI3DHConnectOptions &Options)
void	AI3DHConnector::Disconnect ()
bool	AI3DHConnector::IsDisconnected () const
bool	AI3DHConnector::IsEstablishingConnectionToHub () const
bool	AI3DHConnector::IsConnectedToHub () const
FString	AI3DHConnector::GetHubURL () const
FString	AI3DHConnector::GetSessionId () const

Variables
FConnectedDelegate	AI3DHConnector::OnConnectedDelegate
FConnectErrorDelegate	AI3DHConnector::OnConnectErrorDelegate
FDisconnectedDelegate	AI3DHConnector::OnDisconnectedDelegate

Function Documentation

◆ AddNetworkCredentialCookie()

void AI3DHConnector::AddNetworkCredentialCookie	(	const FString &	CookieKey,
		const FString &	CookieValue )

Adds a network credential cookie.

Parameters

CookieKey	The cookie key.
CookieValue	The cookie value.

◆ AddNetworkCredentialToken()

void AI3DHConnector::AddNetworkCredentialToken	(	const FString &	TokenKey,
		const FString &	TokenValue )

Adds a network credential token.

Parameters

TokenKey	The token key.
TokenValue	The token value.

◆ ConnectToHub()

void AI3DHConnector::ConnectToHub	(	const FString &	HubURL,
		const FString &	SessionId )

Connects to an instant3Dhub session.

Connection follows a simple state machine with 3 states: DISCONNECTED, ESTABLISHING, CONNECTED.

AI3DHConnector::ConnectToHub causes a transition from DISCONNECTED to ESTABLISHING. It has no effect in the other states.

In the ESTABLISHING state the connector will eventually invoke AI3DHConnector::OnConnectedDelegate and transition to the CONNECTED state or invoke AI3DHConnector::OnConnectErrorDelegate and transition back to the DISCONNECTED state.

AI3DHConnector::Disconnect will always revert back to the DISCONNECTED state.

To maintain backwards compatibility with earlier versions, the plugin will present a dialog with the error message and then force exit the application IF AI3DHConnector::OnConnectErrorDelegate is not bound.

See also

AI3DHConnector::Disconnect

AI3DHConnector::IsDisconnected

AI3DHConnector::IsEstablishingConnectionToHub

AI3DHConnector::IsConnectedToHub

Parameters

HubURL	URL of the hub.
SessionId	Identifier for the session.

◆ ConnectToHubWithOptions()

void AI3DHConnector::ConnectToHubWithOptions	(	const FString &	HubURL,
		const FI3DHConnectOptions &	Options )

Connects to an instant3Dhub instance using the provided options.

For a detailed description of the connection logic, see AI3DHConnector::ConnectToHub.

Parameters

HubURL	URL of the hub.
Options	Detailed parameters controlling how to connect.

◆ Disconnect()

void AI3DHConnector::Disconnect

(

)

Disconnects from the connected instant3Dhub session.

Has no effect if already disconnected.

See also

AI3DHConnector::ConnectToHub for details.

◆ GetHubURL()

FString AI3DHConnector::GetHubURL

(

)

const

Returns the HubURL of the current session.

Returns

HubURL of the current session.

◆ GetNetworkCredentialCookies()

const TMap< FString, FString > & AI3DHConnector::GetNetworkCredentialCookies ( ) const

inline

Returns the current network credential cookies used to authenticate hub requests.

Returns

Map from cookie name to cookie value.

◆ GetNetworkCredentialTokens()

const TMap< FString, FString > & AI3DHConnector::GetNetworkCredentialTokens ( ) const

inline

Returns the current network credential tokens used to authenticate hub requests.

Returns

Map from header name to header value.

◆ GetSessionId()

FString AI3DHConnector::GetSessionId

(

)

const

Returns the SessionId of the current session.

Returns

SessionId of the current session.

◆ IsConnectedToHub()

bool AI3DHConnector::IsConnectedToHub

(

)

const

Query if this HubConnector is connected to an instant3Dhub session.

Returns

True if connected to an instant3Dhub session, false if not.

◆ IsDisconnected()

bool AI3DHConnector::IsDisconnected

(

)

const

Query if this HubConnector is currently disconnected.

Returns

True if not connected, false otherwise.

See also

AI3DHConnector::ConnectToHub for details.

◆ IsEstablishingConnectionToHub()

bool AI3DHConnector::IsEstablishingConnectionToHub

(

)

const

Query if this HubConnector is currently establishing a connection.

Returns

True if a connection is being established, false if not.

See also

AI3DHConnector::ConnectToHub for details.

◆ RemoveNetworkCredentialCookie()

void AI3DHConnector::RemoveNetworkCredentialCookie

(

const FString &

CookieKey

)

Removes the network credential cookie identified by CookieKey.

Parameters

CookieKey

The cookie key.

◆ RemoveNetworkCredentialToken()

void AI3DHConnector::RemoveNetworkCredentialToken

(

const FString &

TokenKey

)

Removes the network credential token identified by TokenKey.

Parameters

TokenKey

The token key.

---

Generated by  1.12.0