Navigation
API > API/Plugins > API/Plugins/ConcertClient
Interface for Concert client
| Name | IConcertClient |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertClient/Public/IConcertClient.h |
| Include Path | #include "IConcertClient.h" |
Syntax
class IConcertClient
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertClient() |
IConcertClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TFuture< EConcertResponseCode > ArchiveSession
(
const FGuid& ServerAdminEndpointId, |
Archive a live session on the server hosting the session. | IConcertClient.h | |
TFuture< FConcertAdmin_BatchDeleteSessionResponse > BatchDeleteSessions
(
const FGuid& ServerAdminEndpointId, |
Deletes several live or archives sessions from the server. | IConcertClient.h | |
bool CanAutoConnect() |
Returns true if the client is configured for auto connection. | IConcertClient.h | |
void Configure
(
const UConcertClientConfig* InSettings |
Configure the client settings and its information. | IConcertClient.h | |
TFuture< EConcertResponseCode > CopySession
(
const FGuid& ServerAdminEndpointId, |
Copy a live or and archived session into a new live session on server, matching the configured settings. | IConcertClient.h | |
TFuture< EConcertResponseCode > CreateSession
(
const FGuid& ServerAdminEndpointId, |
Create a session on the server, matching the client configured settings. | IConcertClient.h | |
TFuture< EConcertResponseCode > DeleteSession
(
const FGuid& ServerAdminEndpointId, |
Delete a live or archived session from the server if the client is the owner of the session. | IConcertClient.h | |
void DisconnectSession() |
Disconnect from the current session. | IConcertClient.h | |
TFuture< FConcertAdmin_DropSessionRepositoriesResponse > DropSessionRepositories
(
const FGuid& ServerAdminEndpointId, |
Drop a set of repositories (and delete the files) from the server. | IConcertClient.h | |
TFuture< FConcertAdmin_GetSessionsResponse > GetArchivedSessions
(
const FGuid& ServerAdminEndpointId |
Get the list of the archived sessions data from a server | IConcertClient.h | |
const FConcertClientInfo & GetClientInfo() |
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(). | IConcertClient.h | |
const UConcertClientConfig * GetConfiguration() |
Return The configuration of this client, or null if it hasn't been configured. | IConcertClient.h | |
TSharedPtr< IConcertClientSession > GetCurrentSession() |
Get the current client session (if any). | IConcertClient.h | |
TArray< FConcertServerInfo > GetKnownServers() |
Get the list of discovered server information | IConcertClient.h | |
FConcertConnectionError GetLastConnectionError() |
Get the last connection error | IConcertClient.h | |
TFuture< FConcertAdmin_GetSessionsResponse > GetLiveSessions
(
const FGuid& ServerAdminEndpointId |
Get the list of the live sessions data from a server | IConcertClient.h | |
const FString & GetRole() |
Get the role of this client (eg, MultiUser, DisasterRecovery, etc) | IConcertClient.h | |
EConcertSendReceiveState GetSendReceiveState() |
Get the send/receive state for this session. | IConcertClient.h | |
TFuture< FConcertAdmin_GetAllSessionsResponse > GetServerSessions
(
const FGuid& ServerAdminEndpointId |
Get the list of sessions available on a server | IConcertClient.h | |
TFuture< FConcertAdmin_GetSessionActivitiesResponse > GetSessionActivities
(
const FGuid& ServerAdminEndpointId, |
Get the specified session activities, ordered by Activity ID (ascending) from a live or archived session without being connected to it. | IConcertClient.h | |
TFuture< FConcertAdmin_GetSessionClientsResponse > GetSessionClients
(
const FGuid& ServerAdminEndpointId, |
Get the list of clients connected to a session on the server | IConcertClient.h | |
| Get the connection status of client session or disconnected if no session is present | IConcertClient.h | ||
TFuture< FConcertAdmin_GetSessionRepositoriesResponse > GetSessionRepositories
(
const FGuid& ServerAdminEndpointId |
Request the list of existing session repositories from the server. | IConcertClient.h | |
bool IsAutoConnecting() |
Returns true if the client has an active auto connection routine. | IConcertClient.h | |
bool IsConfigured() |
Return true if the client has been configured. | IConcertClient.h | |
bool IsDiscoveryEnabled() |
Returns true if server discovery is enabled. | IConcertClient.h | |
bool IsOwnerOf
(
const FConcertSessionInfo& InSessionInfo |
Does the client think it is the owner of the session? | IConcertClient.h | |
bool IsStarted() |
Returns if the client has already been started up. | IConcertClient.h | |
TFuture< EConcertResponseCode > JoinSession
(
const FGuid& ServerAdminEndpointId, |
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. | IConcertClient.h | |
TFuture< FConcertAdmin_MountSessionRepositoryResponse > MountSessionRepository
(
const FGuid& ServerAdminEndpointId, |
Create or load a repository (directory structure) containing sessions. | IConcertClient.h | |
FOnConcertClientSessionGetPreConnectionTasks & OnGetPreConnectionTasks() |
Get the delegate that is called to get the pre-connection tasks for a client session | IConcertClient.h | |
FSimpleMulticastDelegate & OnKnownServersUpdated() |
Get the delegate callback for when the known server list is updated | IConcertClient.h | |
FOnConcertClientSessionConnectionChanged & OnSessionConnectionChanged() |
Get the delegate that is called when the session connection state changes | IConcertClient.h | |
FOnConcertClientSessionStartupOrShutdown & OnSessionShutdown() |
Get the delegate that is called right before the client session shutdown | IConcertClient.h | |
FOnConcertClientSessionStartupOrShutdown & OnSessionStartup() |
Get the delegate that is called right before the client session startup | IConcertClient.h | |
TFuture< EConcertResponseCode > RenameSession
(
const FGuid& ServerAdminEndpointId, |
Rename a live or archived session if the client has the permission. | IConcertClient.h | |
TFuture< EConcertResponseCode > RestoreSession
(
const FGuid& ServerAdminEndpointId, |
Copy an archived session into a new live session on the server, matching the client configured settings. | IConcertClient.h | |
void SetSendReceiveState
(
EConcertSendReceiveState InSendReceiveState |
Set the send/receive state for this session. | IConcertClient.h | |
void Shutdown () |
Shutdown the client, its discovery and session, if any. | IConcertClient.h | |
void StartAutoConnect() |
Start attempting to auto connect the client to the default session on the default server. | IConcertClient.h | |
void StartDiscovery () |
Start the discovery service for the client This will look for Concert server and populate the known servers list | IConcertClient.h | |
void Startup() |
Startup the client, this can be called multiple time Configure needs to be called before startup | IConcertClient.h | |
void StopAutoConnect() |
Stop the current auto connection if currently enabled. | IConcertClient.h | |
void StopDiscovery() |
Stop the discovery service for the client | IConcertClient.h |