1. Epic GamesDeveloper
  3. IConcertClient

IConcertClient

Interface for Concert client

API > API/Plugins > API/Plugins/ConcertClient

References

   
Module ConcertClient
Header /Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertClient/Public/IConcertClient.h
Include #include "IConcertClient.h"

Syntax

class IConcertClient

Remarks

Interface for Concert client

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TFuture< EConcertResponseCode >

ArchiveSession ( const FGuid& ServerAdminEndpointId,
const FConcertArchiveSessionArgs& ArchiveSessionArgs
)

 Archive a live session on the server hosting the session.
Public function TFuture< FConcertAdmin_BatchDeleteSessionResponse >

BatchDeleteSessions ( const FGuid& ServerAdminEndpointId,
const FConcertBatchDeleteSessionsArgs& BatchDeletionArgs
)

 Deletes several live or archives sessions from the server.
Public function Const bool Returns true if the client is configured for auto connection.
Public function void

Configure ( const UConcertClientConfig* InSettings
)

 Configure the client settings and its information.
Public function TFuture< EConcertResponseCode >

CopySession ( const FGuid& ServerAdminEndpointId,
const FConcertCopySessionArgs& CopySessionArgs
)

 Copy a live or and archived session into a new live session on server, matching the configured settings.
Public function TFuture< EConcertResponseCode >

CreateSession ( const FGuid& ServerAdminEndpointId,
const FConcertCreateSessionArgs& CreateSessionArgs
)

 Create a session on the server, matching the client configured settings.
Public function TFuture< EConcertResponseCode >

DeleteSession ( const FGuid& ServerAdminEndpointId,
const FGuid& SessionId
)

 Delete a live or archived session from the server if the client is the owner of the session.
Public function void Disconnect from the current session.
Public function Const TFuture< FConcertAdmin_DropSessionRepositoriesResponse >

DropSessionRepositories ( const FGuid& ServerAdminEndpointId,
const TArray< FGuid >& RepositoryIds
)

 Drop a set of repositories (and delete the files) from the server.
Public function Const TFuture< FConcertAdmin_GetSessionsResponse >

GetArchivedSessions ( const FGuid& ServerAdminEndpointId
)

 Get the list of the archived sessions data from a server
Public function Const const FConcertClientInfo & Get the client information passed to Configure() if the client is not in a session, otherwise, returns the current session client info as returned by IConcertClientSession::GetLocalClientInfo().
Public function Const const UConcertClientConfig * Return The configuration of this client, or null if it hasn't been configured.
Public function Const TSharedPtr< IConcertClientSession > Get the current client session (if any).
Public function Const TArray< FConcertServerInfo > Get the list of discovered server information
Public function Const FConcertConnectionError Get the last connection error
Public function Const TFuture< FConcertAdmin_GetSessionsResponse >

GetLiveSessions ( const FGuid& ServerAdminEndpointId
)

 Get the list of the live sessions data from a server
Public function Const const FString &

GetRole ()

 Get the role of this client (eg, MultiUser, DisasterRecovery, etc)
Public function Const EConcertSendReceiveState Get the send/receive state for this session.
Public function Const TFuture< FConcertAdmin_GetAllSessionsResponse >

GetServerSessions ( const FGuid& ServerAdminEndpointId
)

 Get the list of sessions available on a server
Public function Const TFuture< FConcertAdmin_GetSessionActivitiesResponse >

GetSessionActivities ( const FGuid& ServerAdminEndpointId,
const FGuid& SessionId,
int64 FromActivityId,
int64 ActivityCount,
bool bIncludeDetails
)

 Get the specified session activities, ordered by Activity ID (ascending) from a live or archived session without being connected to it.
Public function Const TFuture< FConcertAdmin_GetSessionClientsResponse >

GetSessionClients ( const FGuid& ServerAdminEndpointId,
const FGuid& SessionId
)

 Get the list of clients connected to a session on the server
Public function Const EConcertConnectionStatus Get the connection status of client session or disconnected if no session is present
Public function Const TFuture< FConcertAdmin_GetSessionRepositoriesResponse >

GetSessionRepositories ( const FGuid& ServerAdminEndpointId
)

 Request the list of existing session repositories from the server.
Public function Const bool Returns true if the client has an active auto connection routine.
Public function Const bool Return true if the client has been configured.
Public function Const bool Returns true if server discovery is enabled.
Public function Const bool

IsOwnerOf ( const FConcertSessionInfo& InSessionInfo
)

 Does the client think it is the owner of the session?
Public function Const bool Returns if the client has already been started up.
Public function TFuture< EConcertResponseCode >

JoinSession ( const FGuid& ServerAdminEndpointId,
const FGuid& SessionId
)

 Join a session on the server, the settings of the sessions needs to be compatible with the client settings or the connection will be refused.
Public function Const TFuture< FConcertAdmin_MountSessionRepositoryResponse >

MountSessionRepository ( const FGuid& ServerAdminEndpointId,
const FString& RepositoryRootDir,
const FGuid& RepositoryId,
bool bCreateIfNotExist,
bool bAsDefault
)

 Create or load a repository (directory structure) containing sessions.
Public function FOnConcertClientSessionGetPreConnectionTasks & Get the delegate that is called to get the pre-connection tasks for a client session
Public function FSimpleMulticastDelegate & Get the delegate callback for when the known server list is updated
Public function FOnConcertClientSessionConnectionChanged & Get the delegate that is called when the session connection state changes
Public function FOnConcertClientSessionStartupOrShutdown & Get the delegate that is called right before the client session shutdown
Public function FOnConcertClientSessionStartupOrShutdown & Get the delegate that is called right before the client session startup
Public function TFuture< EConcertResponseCode >

RenameSession ( const FGuid& ServerAdminEndpointId,
const FGuid& SessionId,
const FString& NewName
)

 Rename a live or archived session if the client has the permission.
Public function TFuture< EConcertResponseCode >

RestoreSession ( const FGuid& ServerAdminEndpointId,
const FConcertCopySessionArgs& RestoreSessionArgs
)

 Copy an archived session into a new live session on the server, matching the client configured settings.
Public function void Set the send/receive state for this session.
Public function void Shutdown the client, its discovery and session, if any.
Public function void Start attempting to auto connect the client to the default session on the default server.
Public function void Start the discovery service for the client This will look for Concert server and populate the known servers list
Public function void

Startup ()

 Startup the client, this can be called multiple time Configure needs to be called before startup
Public function void Stop the current auto connection if currently enabled.
Public function void Stop the discovery service for the client

Deprecated Functions

  Type Name Description
Public function Virtual Const bool Use GetSendReceiveState to query the live update status.
Public function Virtual void Use SetSendReceiveState to change live update status.
Public function Virtual void Use SetSendReceiveState to change live update status.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page