Navigation
| Name | Concert |
| Type | Developer |
| Part of Plugins | Concert - Main |
| Location | /Engine/Plugins/Developer/Concert/ConcertMain/Source/Concert/ |
| Module Build Rules | Concert.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FConcertSequencedCustomEventManager | Allows users to reserve a spot in the outbound queues. |
| FConcertSessionCommonImpl | 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. |
| FConcertSessionCustomEventHandlerBase | Common implementation of a session custom event handler. |
| TConcertFunctionSessionCustomEventHandler | Implementation of a session custom event handler that calls a function with the correct event type in the handler function signature. |
| TConcertFunctionSessionCustomRequestHandler | Implementation of a session custom request handler that calls a function with the correct request type in the handler function signature. |
| TConcertFutureSessionCustomResponseHandler | Implementation of a session custom response handler that uses a future to dispatch back the response |
| TConcertRawSessionCustomEventHandler | Implementation of a session custom event handler that uses a raw member function pointer with the correct event type in the handler function signature. |
| TConcertRawSessionCustomRequestHandler | Implementation of a session custom request handler that calls a raw member function with the correct request type in the handler function signature. |
Structs
Interfaces
| Name | Remarks |
|---|---|
| IConcertClientSession | Interface for Concert client sessions |
| IConcertModule | Interface for the Main Concert module. |
| IConcertServerEventSink | Interface for events that Concert server can emit |
| IConcertServerSession | Interface for Concert server sessions |
| IConcertSession | Interface for Concert sessions |
| IConcertSessionCustomEventHandler | Interface for session custom event handler |
| IConcertSessionCustomRequestHandler | Interface for session custom request handler |
| IConcertSessionCustomResponseHandler | Interface for session custom request handler TODO: replace by a generalized erased promise/future pair?? |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FActivityID | int64 | ConcertMessageData.h | |
| FArchiveSession_WithSession | TMulticastDelegate_SixParams< void, bool, const IConcertServer &, TSharedRef< IConcertServerSession >, const FString &, const FConcertSessionInfo &, const FConcertSessionFilter & > | ConcertServerEvents.h | |
| FArchiveSession_WithWorkingDir | TMulticastDelegate_SixParams< void, bool, const IConcertServer &, const FString &, const FString &, const FConcertSessionInfo &, const FConcertSessionFilter & > | ConcertServerEvents.h | |
| FConcertClientLogEvent | TMulticastDelegate_TwoParams< void, const IConcertClient &, const FConcertLog & > | ConcertTransportEvents.h | |
| FConcertServerLogEvent | TMulticastDelegate_TwoParams< void, const IConcertServer &, const FConcertLog & > | ConcertTransportEvents.h | |
| FConcertTransportLoggingEnabledChanged | TMulticastDelegate_OneParam< void, bool > | ConcertTransportEvents.h | |
| FCopySession | TMulticastDelegate_FiveParams< void, bool, const IConcertServer &, TSharedRef< IConcertServerSession >, const FString &, const FConcertSessionFilter & > | ConcertServerEvents.h | |
| FExportSession | TMulticastDelegate_SixParams< void, bool, const IConcertServer &, const FGuid &, const FString &, const FConcertSessionFilter &, bool > | ConcertServerEvents.h | |
| FLogListener | TFunction< void(const FConcertLog &)> | ConcertUtil.h | |
| FOnArchivedSessionCreated | TMulticastDelegate_FourParams< void, bool, const IConcertServer &, const FString &, const FConcertSessionInfo & > | ConcertServerEvents.h | |
| FOnArchivedSessionDestroyed | TMulticastDelegate_TwoParams< void, const IConcertServer &, const FGuid & > | ConcertServerEvents.h | |
| FOnArchivedSessionRenamed | TMulticastDelegate_ThreeParams< void, const IConcertServer &, const FString &, const FConcertSessionInfo & > | ConcertServerEvents.h | |
| FOnConcertClientSessionClientChanged | TMulticastDelegate_ThreeParams< void, IConcertClientSession &, EConcertClientStatus, const FConcertSessionClientInfo & > | IConcertSession.h | |
| FOnConcertClientSessionConnectionChanged | TMulticastDelegate_TwoParams< void, IConcertClientSession &, EConcertConnectionStatus > | IConcertSession.h | |
| FOnConcertClientSessionTick | TMulticastDelegate_TwoParams< void, IConcertClientSession &, float > | IConcertSession.h | |
| FOnConcertServerSessionClientChanged | TMulticastDelegate_ThreeParams< void, IConcertServerSession &, EConcertClientStatus, const FConcertSessionClientInfo & > | IConcertSession.h | |
| FOnConcertServerSessionTick | TMulticastDelegate_TwoParams< void, IConcertServerSession &, float > | IConcertSession.h | |
| FOnConcertSessionRenamed | TMulticastDelegate_TwoParams< void, const FString &, const FString & > | IConcertSession.h | |
| FOnLiveSessionCreated | TMulticastDelegate_ThreeParams< void, bool, const IConcertServer &, TSharedRef< IConcertServerSession > > | ConcertServerEvents.h | |
| FOnLiveSessionDestroyed | TMulticastDelegate_TwoParams< void, const IConcertServer &, TSharedRef< IConcertServerSession > > | ConcertServerEvents.h | |
| FOnLiveSessionRenamed | TMulticastDelegate_TwoParams< void, const IConcertServer &, TSharedRef< IConcertServerSession > > | ConcertServerEvents.h | |
| FRestoreSession | TMulticastDelegate_SixParams< void, bool, const IConcertServer &, const FGuid &, const FString &, const FConcertSessionInfo &, const FConcertSessionFilter & > | ConcertServerEvents.h |
Enums
Public
| Name | Remarks |
|---|---|
| EBatchSessionDeletionFlags | |
| EConcertClientStatus | Status for Concert session clients |
| EConcertCompressionDetails | |
| EConcertConnectionResult | Connection Result for Concert client session |
| EConcertConnectionStatus | Connection status for Concert client sessions |
| EConcertLogMessageAction | |
| EConcertPayloadCompressionType | |
| EConcertPayloadSerializationMethod | |
| EConcertSendReceiveState | |
| EConcertServerFlags | |
| EConcertSessionRepositoryMountResponseCode | Response code returned when trying to mount a session repository on the server. |
| EConcertSessionResponseCode | Response codes for a session custom request |
| EConcertSessionState | |
| EConcertVersionValidationMode | Modes that can be used when validating Concert version information |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArchiveSession_WithSession & ConcertServerEvents::ArchiveSession_WithSession() |
ConcertServerEvents.h | ||
FArchiveSession_WithWorkingDir & ConcertServerEvents::ArchiveSession_WithWorkingDir() |
ConcertServerEvents.h | ||
FCopySession & ConcertServerEvents::CopySession() |
ConcertServerEvents.h | ||
FExportSession & ConcertServerEvents::ExportSession() |
ConcertServerEvents.h | ||
FOnArchivedSessionCreated & ConcertServerEvents::OnArchivedSessionCreated() |
ConcertServerEvents.h | ||
FOnArchivedSessionDestroyed & ConcertServerEvents::OnArchivedSessionDestroyed() |
ConcertServerEvents.h | ||
FOnArchivedSessionRenamed & ConcertServerEvents::OnArchivedSessionRenamed() |
ConcertServerEvents.h | ||
FOnLiveSessionCreated & ConcertServerEvents::OnLiveSessionCreated() |
ConcertServerEvents.h | ||
FOnLiveSessionDestroyed & ConcertServerEvents::OnLiveSessionDestroyed() |
ConcertServerEvents.h | ||
FOnLiveSessionRenamed & ConcertServerEvents::OnLiveSessionRenamed() |
ConcertServerEvents.h | ||
FRestoreSession & ConcertServerEvents::RestoreSession() |
ConcertServerEvents.h | ||
| Copy the specified data size from a source archive into a destination archive. | ConcertUtil.h | ||
IConcertTransportLoggerRef ConcertUtil::CreateLogger
(
const FConcertEndpointContext& InOwnerContext, |
Factory function for use with FConcertTransportLoggerFactory | ConcertUtil.h | |
bool ConcertUtil::DeleteDirectoryTree
(
const TCHAR* InDirectoryToDelete, |
Delete a directory tree via a move and delete | ConcertUtil.h | |
void ConcertUtil::SetVerboseLogging
(
bool bInState |
Turn on verbose logging for all loggers (including console loggers). | ConcertUtil.h | |
bool operator!
(
EConcertServerFlags E |
ConcertMessageData.h | ||
bool operator!
(
EConcertCompressionDetails E |
ConcertMessageData.h | ||
bool operator!
(
EBatchSessionDeletionFlags E |
ConcertMessages.h | ||
| ConcertMessageData.h | |||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
EConcertServerFlags & operator&=
(
EConcertServerFlags& Lhs, |
ConcertMessageData.h | ||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
| ConcertMessageData.h | |||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
EConcertServerFlags & operator^=
(
EConcertServerFlags& Lhs, |
ConcertMessageData.h | ||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
| ConcertMessageData.h | |||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
EConcertServerFlags & operator|=
(
EConcertServerFlags& Lhs, |
ConcertMessageData.h | ||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
| ConcertMessageData.h | |||
| ConcertMessageData.h | |||
| ConcertMessages.h | |||
bool UE::Concert::Compression::DataIsCompressed
(
EConcertCompressionDetails InFormat |
Returns truen if the compression details is set to compressed format. | ConcertMessageData.h | |
bool UE::Concert::Compression::DataIsCompressedWithOodle
(
EConcertCompressionDetails InFormat |
Returns true if we are suppose to use Oodle for compression. | ConcertMessageData.h | |
bool UE::Concert::Compression::DataIsUncompressed
(
EConcertCompressionDetails InFormat |
Returns true if the compression details is set to uncompressed format. | ConcertMessageData.h | |
| Get the named compression algorithm to invoke with serializer and memory compressors. | ConcertMessageData.h | ||
| Get the named compression algorithm based on the provided details. | ConcertMessageData.h | ||
EConcertCompressionDetails UE::Concert::Compression::GetCompressionDetails
(
SizeType DataSize |
Based on the data size return the current compression details to store. | ConcertMessageData.h | |
| Get the default flags to use when invoking the compressor. | ConcertMessageData.h | ||
| Add in the compression flags to the concert compression details enum. | ConcertMessageData.h | ||
EConcertCompressionDetails UE::Concert::Compression::GetCompressionFromNamedType
(
FName NamedMethod, |
For a given named compression algorithm and compression flags convert it into a EConcertCompressionDetails | ConcertMessageData.h | |
| Get the compression enum value given the concert compression settings. | ConcertMessageData.h | ||
bool UE::Concert::Compression::ShouldCompress
(
SizeType DataSize |
Based on the size of the data to compress indicate if we should invoke the compressor. | ConcertMessageData.h |