Navigation
API > API/Plugins > API/Plugins/ConcertServer
Interface for Concert server
| Name | IConcertServer |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertServer/Public/IConcertServer.h |
| Include Path | #include "IConcertServer.h" |
Syntax
class IConcertServer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertServer() |
IConcertServer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Archive a Concert session on the server. | IConcertServer.h | ||
void Configure
(
const UConcertServerConfig* ServerConfig |
Configure the Concert settings and its information | IConcertServer.h | |
TSharedPtr< IConcertServerSession > CopySession
(
const FGuid& SrcSessionId, |
Create a new live server session from another session. | IConcertServer.h | |
TSharedPtr< IConcertServerSession > CreateSession
(
const FConcertSessionInfo& SessionInfo, |
Create a new Concert server session based on the passed session info | IConcertServer.h | |
FConcertSessionInfo CreateSessionInfo() |
Create a session description for this server | IConcertServer.h | |
bool DestroySession
(
const FGuid& SessionId, |
Destroy a live or archived Concert server session. | IConcertServer.h | |
bool ExportSession
(
const FGuid& SessionId, |
Copy the session data to a destination folder for external usage. | IConcertServer.h | |
| Get the ID of an archived session from its name. | IConcertServer.h | ||
TOptional< FConcertSessionInfo > GetArchivedSessionInfo
(
const FGuid& SessionId |
Gets an archived session info | IConcertServer.h | |
TArray< FConcertSessionInfo > GetArchivedSessionInfos() |
Gets the archived session information list | IConcertServer.h | |
const UConcertServerConfig * GetConfiguration() |
Return The configuration of this server, or null if it hasn't been configured. | IConcertServer.h | |
TSharedPtr< IConcertServerSession > GetLiveSession
(
const FGuid& SessionId |
Get a live server session | IConcertServer.h | |
| Get the ID of a live session from its name. | IConcertServer.h | ||
TArray< FConcertSessionInfo > GetLiveSessionInfos() |
Get the live session information list | IConcertServer.h | |
TArray< TSharedPtr< IConcertServerSession > > GetLiveSessions() |
Get all live server sessions | IConcertServer.h | |
FMessageAddress GetRemoteAddress
(
const FGuid& AdminEndpointId |
Gets the address of a remote admin endpoint, i.e. a client that is sending FConcertEndpointDiscoveryEvents. | IConcertServer.h | |
| Gets all remote admin endpoint IDs. | IConcertServer.h | ||
const FString & GetRole() |
Get the role of this server (eg, MultiUser, DisasterRecovery, etc) | IConcertServer.h | |
const FConcertServerInfo & GetServerInfo() |
Get the server information set by Configure | IConcertServer.h | |
bool IsConfigured() |
Return true if the server has been configured. | IConcertServer.h | |
bool IsStarted() |
Returns if the server has already been started up. | IConcertServer.h | |
FOnConcertMessageAcknowledgementReceivedFromLocalEndpoint & OnConcertMessageAcknowledgementReceived() |
Callback when a message has been acknowledged by a remote endpoint | IConcertServer.h | |
FOnConcertParticipantCanJoinSession & OnConcertParticipantCanJoinSession() |
Callback to check whether a participant should be allowed to join a session. | IConcertServer.h | |
FOnConcertServerSessionStartup & OnConcertServerSessionStartup() |
Callback for when a concert server session has been created. | IConcertServer.h | |
FOnConcertServerStartup & OnConcertServerStartup() |
Callback for when a concert server has been created. | IConcertServer.h | |
FOnConcertRemoteEndpointConnectionChanged & OnRemoteEndpointConnectionChanged() |
Callback when a remote admin endpoint connection changes. | IConcertServer.h | |
bool RenameSession
(
const FGuid& SessionId, |
Rename a live or archived Concert session on the server. | IConcertServer.h | |
TSharedPtr< IConcertServerSession > RestoreSession
(
const FGuid& SessionId, |
Restore an archived Concert server session based on the passed session info | IConcertServer.h | |
void Shutdown () |
Shutdown the server, this can be called multiple time with no ill effect. | IConcertServer.h | |
void Startup() |
Startup the server, this can be called multiple time Configure needs to be called before startup | IConcertServer.h |