IConcertClientReplicationManager | Unreal Engine 5.5 Documentation

API > API/Plugins > API/Plugins/ConcertSyncClient > API/Plugins/ConcertSyncClient/Replication

References


Module	ConcertSyncClient
Header	/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/Replication/IConcertClientReplicationManager.h
Include	#include "Replication/IConcertClientReplicationManager.h"

Syntax

class IConcertClientReplicationManager

Remarks

Handles all communication with the server regarding replication.

Keeps a list of properties to send along with their send rules. Tells the server which properties this client is interested in receiving.

Destructors

	Type	Name	Description
		~IConcertClientReplicationManager ()

Functions

Type	Name	Description
bool	CanJoin ()	Whether it is valid to call JoinReplicationSession right now.
TFuture< FConcertReplication_ChangeMuteState_Response >	ChangeMuteState ( FConcertReplication_ChangeMuteState_Request Request )	Requests to change the global mute state of objects.
TFuture< FConcertReplication_ChangeStream_Response >	ChangeStream ( FConcertReplication_ChangeStream_Request Args )	Requests to change the client's registered stream.
EAuthorityEnumerationResult	ForEachClientOwnedObject ( TFunctionRef< EBreakBehavior(const FSoftObjectPath&Object, TSet< FGuid >&&OwningStreams)> Callback )	Iterates through all objects that this client has authority over.
EStreamEnumerationResult	ForEachRegisteredStream ( TFunctionRef< EBreakBehavior(const FConcertReplicationStream&Stream)> Callback )	Iterates the streams the client has registered with the server.
ESyncControlEnumerationResult	ForEachSyncControlledObject ( TFunctionRef< EBreakBehavior(const FConcertObjectInStreamID&Object)> Callback )	Iterates through all objects the server told the client to replicate, which happens when this client has taken authority and another client wants to receive the data.
TMap< FSoftObjectPath, TSet< FGuid > >	GetClientOwnedObjects ()
TSet< FGuid >	GetClientOwnedStreamsForObject ( const FSoftObjectPath& ObjectPath )
TArray< FConcertReplicationStream >	GetRegisteredStreams ()
TSet< FConcertObjectInStreamID >	GetSyncControlledObjects ()	Util for converting all sync controlled objects into a TSet.
bool	HasRegisteredStreams ()
bool	HasSyncControl ( const FConcertObjectInStreamID& Object )
bool	IsConnectedToReplicationSession ()	Whether JoinReplicationSession completed successfully and LeaveReplicationSession has not yet been called.
TFuture< UE::ConcertSyncClient::Replication::FJoinReplicatedSessionResult >	JoinReplicationSession ( UE::ConcertSyncClient::Replication::FJoinReplicatedSessionArgs Args )	Joins a replication session.
void	LeaveReplicationSession ()	Leaves the current replication session.
TFuture< FConcertReplication_ChangeMuteState_Response >	MuteObjects ( TConstArrayView< FSoftObjectPath > Objects, EConcertReplicationMuteOption Flags )	Util function that will mute all of Objects.
uint32	NumSyncControlledObjects ()
FOnPostAuthorityChanged &	OnPostAuthorityChanged ()	Called right after GetClientOwnedObjects has changed.
FOnRemoteEditApplied &	OnPostRemoteEditApplied ()	Called after updating any local state in response to the server notifying us that the local client's content was remotely edited.
FOnPostStreamsChanged &	OnPostStreamsChanged ()	Called right after the result of GetRegisteredStreams has changed.
FSyncControlChanged &	OnPostSyncControlChanged ()	Called just after sync control change is applied.
FOnPreAuthorityChanged &	OnPreAuthorityChanged ()	Called right before GetClientOwnedObjects changes.
FOnRemoteEditApplied &	OnPreRemoteEditApplied ()	Called before updating any local state in response to the server notifying us that the local client's content was remotely edited.
FOnPreStreamsChanged &	OnPreStreamsChanged ()	Called right before the result of GetRegisteredStreams changes.
FSyncControlChanged &	OnPreSyncControlChanged ()	Called just before sync control change is applied.
TFuture< FConcertReplication_PutState_Response >	PutClientState ( FConcertReplication_PutState_Request Request )	Changes multiple clients' stream, authority, and optionally the global mute state.
TFuture< FConcertReplication_QueryReplicationInfo_Response >	QueryClientInfo ( FConcertReplication_QueryReplicationInfo_Request Args )	Requests replication info about other clients, including the streams registered and which objects they have authority over (i.e. are sending).
TFuture< FConcertReplication_QueryMuteState_Response >	QueryMuteState ( FConcertReplication_QueryMuteState_Request Request )	Gets the global mute state.
TFuture< FConcertReplication_QueryMuteState_Response >	QueryMuteState ( TSet< FSoftObjectPath > Objects )
TFuture< FConcertReplication_ChangeAuthority_Response >	ReleaseAuthorityOf ( TConstArrayView< FSoftObjectPath > Objects )	Util function that will let go over all authority of the given objects.
TFuture< FConcertReplication_ChangeAuthority_Response >	RequestAuthorityChange ( FConcertReplication_ChangeAuthority_Request Args )	Requests from the server to change the authority over some objects.
TFuture< FConcertReplication_RestoreContent_Response >	RestoreContent ( FConcertReplication_RestoreContent_Request Request )	Restore this client's stream content and authority to what a client had when they left.
TFuture< FConcertReplication_ChangeAuthority_Response >	TakeAuthorityOver ( TConstArrayView< FSoftObjectPath > Objects )	Util function that will request authority for all streams for the given objects.
TFuture< FConcertReplication_ChangeMuteState_Response >	UnmuteObjects ( TSet< FSoftObjectPath > Objects, EConcertReplicationMuteOption Flags )	Util function that will unmute all of Objects.