1. Epic GamesDeveloper
  3. IConcertSession

IConcertSession

Interface for Concert sessions

API > API/Plugins > API/Plugins/Concert

Inheritance Hierarchy

References

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

Syntax

class IConcertSession

Remarks

Interface for Concert sessions

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Clear a custom event handler for this session
Public function Const bool

FindSessionClient ( const FGuid& EndpointId,
FConcertSessionClientInfo& OutSessionClientInfo
)

 Find the the client for the specified endpoint ID
Public function Const FConcertScratchpadPtr

GetClientScratchpad ( const FGuid& ClientEndpointId
)

 Get the scratchpad associated with the given client ID.
Public function Const const FGuid &

GetId ()

  
Public function Const const FString &

GetName ()

  
Public function Const FConcertScratchpadRef Get the scratchpad associated with this concert session.
Public function Const TArray< FGuid > Get the list of connected client endpoint IDs
Public function Const TArray< FConcertSessionClientInfo > Get the information about all connected clients
Public function Const const FConcertSessionInfo &  
Public function Const FString Give the working directory for this session
Protected function void

InternalClearCustomEventHandler ( const FName& EventMessageType
)

 Clear a custom event handler for this session
Protected function FDelegateHandle Register a custom event handler for this session
Protected function void Register a custom request handler for this session
Protected function void

InternalSendCustomEvent ( const UScriptStruct* EventType,
const void* EventData,
const TArray< FGuid >& DestinationEndpointIds,
EConcertMessageFlags Flags,
TOptional< FConcertSequencedCustomEvent > InSequenceId
)

 Send a custom event event to the given endpoints
Protected function void

InternalSendCustomRequest ( const UScriptStruct* RequestType,
const void* RequestData,
const FGuid& DestinationEndpointId,
const TSharedRef< IConcertSessionCustomResponseHandler >& Handler
)

 Send a custom request to the given endpoint
Protected function void

InternalUnregisterCustomEventHandler ( const FName& EventMessageType,
const FDelegateHandle EventHandle
)

 Unregister a custom event handler for this session
Protected function void

InternalUnregisterCustomEventHandler ( const FName& EventMessageType,
const void* EventHandler
)

  
Protected function void

InternalUnregisterCustomRequestHandler ( const FName& RequestMessageType
)

 Unregister a custom request handler for this session
Public function FDelegateHandle

RegisterCustomEventHandler ( typename TConcertFunctionSessionCustomEventHandler< EventType >::FFuncType Func
)

 Register a custom event handler for this session
Public function FDelegateHandle

RegisterCustomEventHandler ( HandlerType* Handler,
typename TConcertRawSessionCustomEventHandler< EventType, HandlerType >::FFuncType Func
)

 Register a custom event handler for this session
Public function void

RegisterCustomRequestHandler ( typename TConcertFunctionSessionCustomRequestHandler< RequestType, ResponseType >::FFuncType Func
)

 Register a custom request handler for this session
Public function void

RegisterCustomRequestHandler ( HandlerType* Handler,
typename TConcertRawSessionCustomRequestHandler< RequestType, ResponseType, HandlerType >::FFuncType...
)

 Register a custom request handler for this session
Public function void

SendCustomEvent ( const EventType& Event,
const FGuid& DestinationEndpointId,
EConcertMessageFlags Flags,
TOptional< FConcertSequencedCustomEvent > SequencedId
)

 Send a custom event event to the given endpoint
Public function void

SendCustomEvent ( const EventType& Event,
const TArray< FGuid >& DestinationEndpointIds,
EConcertMessageFlags Flags,
TOptional< FConcertSequencedCustomEvent > SequencedId
)

 Send a custom event event to the given endpoints
Public function TFuture< ResponseType >

SendCustomRequest ( const RequestType& Request,
const FGuid& DestinationEndpointId
)

 Send a custom request to the given endpoint
Public function void  
Public function void

Startup ()

  
Public function void Unregister a custom event handler for this session
Public function void

UnregisterCustomEventHandler ( HandlerType* EventHandler
)

 Unregister a custom event handler for this session
Public function void Unregister a custom request handler for this session

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page