1. Epic GamesDeveloper
  3. IConcertServer

IConcertServer

Interface for Concert server

API > API/Plugins > API/Plugins/ConcertServer

References

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

Syntax

class IConcertServer

Remarks

Interface for Concert server

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FGuid

ArchiveSession ( const FGuid& SessionId,
const FString& ArchiveNameOverride,
const FConcertSessionFilter& SessionFilter,
FText& OutFailureReason,
FGuid ArchiveSessionIdOverride
)

 Archive a Concert session on the server.
Public function void

Configure ( const UConcertServerConfig* ServerConfig
)

 Configure the Concert settings and its information
Public function TSharedPtr< IConcertServerSession >

CopySession ( const FGuid& SrcSessionId,
const FConcertSessionInfo& NewSessionInfo,
const FConcertSessionFilter& SessionFilter,
FText& OutFailureReason
)

 Create a new live server session from another session.
Public function TSharedPtr< IConcertServerSession >

CreateSession ( const FConcertSessionInfo& SessionInfo,
FText& OutFailureReason
)

 Create a new Concert server session based on the passed session info
Public function Const FConcertSessionInfo Create a session description for this server
Public function bool

DestroySession ( const FGuid& SessionId,
FText& OutFailureReason
)

 Destroy a live or archived Concert server session.
Public function bool

ExportSession ( const FGuid& SessionId,
const FConcertSessionFilter& SessionFilter,
const FString& DestDir,
bool bAnonymizeData,
FText& OutFailureReason
)

 Copy the session data to a destination folder for external usage.
Public function Const FGuid Get the ID of an archived session from its name.
Public function Const TOptional< FConcertSessionInfo >

GetArchivedSessionInfo ( const FGuid& SessionId
)

 Gets an archived session info
Public function Const TArray< FConcertSessionInfo > Gets the archived session information list
Public function Const const UConcertServerConfig * Return The configuration of this server, or null if it hasn't been configured.
Public function Const TSharedPtr< IConcertServerSession >

GetLiveSession ( const FGuid& SessionId
)

 Get a live server session
Public function Const FGuid

GetLiveSessionIdByName ( const FString& InName
)

 Get the ID of a live session from its name.
Public function Const TArray< FConcertSessionInfo > Get the live session information list
Public function Const TArray< TSharedPtr< IConcertServerSession > > Get all live server sessions
Public function Const FMessageAddress

GetRemoteAddress ( const FGuid& AdminEndpointId
)

 Gets the address of a remote admin endpoint, i.e. a client that is sending FConcertEndpointDiscoveryEvents.
Public function Const TArray< FConcertEndpointContext > Gets all remote admin endpoint IDs.
Public function Const const FString &

GetRole ()

 Get the role of this server (eg, MultiUser, DisasterRecovery, etc)
Public function Const const FConcertServerInfo & Get the server information set by Configure
Public function Const bool Return true if the server has been configured.
Public function Const bool Returns if the server has already been started up.
Public function FOnConcertMessageAcknowledgementReceivedFromLocalEndpoint & Callback when a message has been acknowledged by a remote endpoint
Public function FOnConcertParticipantCanJoinSession & Callback to check whether a participant should be allowed to join a session.
Public function FOnConcertServerSessionStartup & Callback for when a concert server session has been created.
Public function FOnConcertServerStartup & Callback for when a concert server has been created.
Public function FOnConcertRemoteEndpointConnectionChanged & Callback when a remote admin endpoint connection changes.
Public function bool

RenameSession ( const FGuid& SessionId,
const FString& NewName,
FText& OutFailureReason
)

 Rename a live or archived Concert session on the server.
Public function TSharedPtr< IConcertServerSession >

RestoreSession ( const FGuid& SessionId,
const FConcertSessionInfo& SessionInfo,
const FConcertSessionFilter& SessionFilter,
FText& OutFailureReason
)

 Restore an archived Concert server session based on the passed session info
Public function void Shutdown the server, this can be called multiple time with no ill effect.
Public function void

Startup ()

 Startup the server, this can be called multiple time Configure needs to be called before startup

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page