Navigation
API > API/Plugins > API/Plugins/Concert
Interface for Concert sessions
| Name | IConcertSession |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/IConcertSession.h |
| Include Path | #include "IConcertSession.h" |
Syntax
class IConcertSession
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertSession() |
IConcertSession.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearCustomEventHandler() |
Clear a custom event handler for this session | IConcertSession.h | |
bool FindSessionClient
(
const FGuid& EndpointId, |
Find the the client for the specified endpoint ID | IConcertSession.h | |
FConcertScratchpadPtr GetClientScratchpad
(
const FGuid& ClientEndpointId |
Get the scratchpad associated with the given client ID. | IConcertSession.h | |
const FGuid & GetId() |
IConcertSession.h | ||
const FString & GetName() |
IConcertSession.h | ||
FConcertScratchpadRef GetScratchpad() |
Get the scratchpad associated with this concert session. | IConcertSession.h | |
| Get the list of connected client endpoint IDs | IConcertSession.h | ||
TArray< FConcertSessionClientInfo > GetSessionClients() |
Get the information about all connected clients | IConcertSession.h | |
const FConcertSessionInfo & GetSessionInfo() |
IConcertSession.h | ||
FString GetSessionWorkingDirectory() |
Give the working directory for this session | IConcertSession.h | |
FDelegateHandle RegisterCustomEventHandler
(
typename TConcertFunctionSessionCustomEventHandler< EventType >::FFuncType Func |
Register a custom event handler for this session | IConcertSession.h | |
FDelegateHandle RegisterCustomEventHandler
(
HandlerType* Handler, |
Register a custom event handler for this session | IConcertSession.h | |
void RegisterCustomRequestHandler
(
typename TConcertFunctionSessionCustomRequestHandler< RequestType, ResponseType >::FFuncType Func |
Register a custom request handler for this session | IConcertSession.h | |
void RegisterCustomRequestHandler
(
HandlerType* Handler, |
Register a custom request handler for this session | IConcertSession.h | |
void SendCustomEvent
(
const EventType& Event, |
Send a custom event event to the given endpoint | IConcertSession.h | |
void SendCustomEvent
(
const EventType& Event, |
Send a custom event event to the given endpoints | IConcertSession.h | |
| Send a custom request to the given endpoint | IConcertSession.h | ||
void Shutdown() |
IConcertSession.h | ||
void Startup() |
IConcertSession.h | ||
void UnregisterCustomEventHandler
(
const FDelegateHandle EventHandle |
Unregister a custom event handler for this session | IConcertSession.h | |
void UnregisterCustomEventHandler
(
HandlerType* EventHandler |
Unregister a custom event handler for this session | IConcertSession.h | |
void UnregisterCustomRequestHandler() |
Unregister a custom request handler for this session | IConcertSession.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void InternalClearCustomEventHandler
(
const FName& EventMessageType |
Clear a custom event handler for this session | IConcertSession.h | |
FDelegateHandle InternalRegisterCustomEventHandler
(
const FName& EventMessageType, |
Register a custom event handler for this session | IConcertSession.h | |
void InternalRegisterCustomRequestHandler
(
const FName& RequestMessageType, |
Register a custom request handler for this session | IConcertSession.h | |
void InternalSendCustomEvent
(
const UScriptStruct* EventType, |
Send a custom event event to the given endpoints | IConcertSession.h | |
void InternalSendCustomRequest
(
const UScriptStruct* RequestType, |
Send a custom request to the given endpoint | IConcertSession.h | |
void InternalUnregisterCustomEventHandler
(
const FName& EventMessageType, |
Unregister a custom event handler for this session | IConcertSession.h | |
void InternalUnregisterCustomEventHandler
(
const FName& EventMessageType, |
IConcertSession.h | ||
void InternalUnregisterCustomRequestHandler
(
const FName& RequestMessageType |
Unregister a custom request handler for this session | IConcertSession.h |