Navigation
API > API/Plugins > API/Plugins/Concert
Common implementation for Concert Client and Server sessions (
This doesn't inherit from any session interface, but does implement some of their API with a "Common" prefix on the function names. Interface implementations can also inherit from this common impl and then call the "Common" functions from the interface overrides.
| Name | FConcertSessionCommonImpl |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/Public/ConcertSession.h |
| Include Path | #include "ConcertSession.h" |
Syntax
class FConcertSessionCommonImpl
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FConcertSessionCommonImpl
(
const FConcertSessionInfo& InSessionInfo |
ConcertSession.h |
Structs
| Name | Remarks |
|---|---|
| FSessionClient | Map of clients connected to this session (excluding us if we're a client session) |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CommonClearCustomEventHandler
(
const FName& EventMessageType |
ConcertSession.h | ||
bool CommonFindSessionClient
(
const FGuid& EndpointId, |
ConcertSession.h | ||
FConcertScratchpadPtr CommonGetClientScratchpad
(
const FGuid& ClientEndpointId |
ConcertSession.h | ||
const FGuid & CommonGetId() |
ConcertSession.h | ||
const FString & CommonGetName() |
ConcertSession.h | ||
FConcertScratchpadRef CommonGetScratchpad() |
ConcertSession.h | ||
| ConcertSession.h | |||
TArray< FConcertSessionClientInfo > CommonGetSessionClients() |
ConcertSession.h | ||
const FConcertSessionInfo & CommonGetSessionInfo() |
ConcertSession.h | ||
void CommonHandleCustomEvent
(
const FConcertMessageContext& Context |
ConcertSession.h | ||
TFuture< FConcertSession_CustomResponse > CommonHandleCustomRequest
(
const FConcertMessageContext& Context |
ConcertSession.h | ||
FDelegateHandle CommonRegisterCustomEventHandler
(
const FName& EventMessageType, |
ConcertSession.h | ||
void CommonRegisterCustomRequestHandler
(
const FName& RequestMessageType, |
ConcertSession.h | ||
void CommonSetName
(
const FString& NewName |
ConcertSession.h | ||
void CommonShutdown() |
ConcertSession.h | ||
void CommonStartup() |
ConcertSession.h | ||
void CommonUnregisterCustomEventHandler
(
const FName& EventMessageType, |
ConcertSession.h | ||
void CommonUnregisterCustomEventHandler
(
const FName& EventMessageType, |
ConcertSession.h | ||
void CommonUnregisterCustomRequestHandler
(
const FName& RequestMessageType |
ConcertSession.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CommonBuildCustomEvent
(
const UScriptStruct* EventType, |
ConcertSession.h | ||
static bool CommonBuildCustomRequest
(
const UScriptStruct* RequestType, |
ConcertSession.h | ||
static void CommonHandleCustomResponse
(
const FConcertSession_CustomResponse& Response, |
ConcertSession.h |
See Also
- IConcertSession for the API description).