Navigation
API > API/Plugins > API/Plugins/ConcertSyncClient
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.
| Name | IConcertClientReplicationManager |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/Replication/IConcertClientReplicationManager.h |
| Include Path | #include "Replication/IConcertClientReplicationManager.h" |
Syntax
class IConcertClientReplicationManager
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConcertClientReplicationManager() |
Replication/IConcertClientReplicationManager.h |
Enums
Public
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnPostAuthorityChanged | TMulticastDelegate_NoParams< void > | Replication/IConcertClientReplicationManager.h | |
| FOnPostStreamsChanged | TMulticastDelegate_NoParams< void > | Replication/IConcertClientReplicationManager.h | |
| FOnPreAuthorityChanged | TMulticastDelegate_NoParams< void > | Replication/IConcertClientReplicationManager.h | |
| FOnPreStreamsChanged | TMulticastDelegate_NoParams< void > | Replication/IConcertClientReplicationManager.h | |
| FOnRemoteEditApplied | TMulticastDelegate_OneParam< void, const UE::ConcertSyncClient::Replication::FRemoteEditEvent & > | Replication/IConcertClientReplicationManager.h | |
| FSyncControlChanged | TMulticastDelegate_NoParams< void > | Replication/IConcertClientReplicationManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanJoin () |
Whether it is valid to call JoinReplicationSession right now. | Replication/IConcertClientReplicationManager.h | |
| Requests to change the global mute state of objects. | Replication/IConcertClientReplicationManager.h | ||
| Requests to change the client's registered stream. | Replication/IConcertClientReplicationManager.h | ||
EAuthorityEnumerationResult ForEachClientOwnedObject
(
TFunctionRef< EBreakBehavior(const FSoftObjectPath&Object, TSet< FGuid >&&OwningStreams)> Callback |
Iterates through all objects that this client has authority over. | Replication/IConcertClientReplicationManager.h | |
EStreamEnumerationResult ForEachRegisteredStream
(
TFunctionRef< EBreakBehavior(const FConcertReplicationStream&Stream)> Callback |
Iterates the streams the client has registered with the server. | Replication/IConcertClientReplicationManager.h | |
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. | Replication/IConcertClientReplicationManager.h | |
TMap< FSoftObjectPath, TSet< FGuid > > GetClientOwnedObjects() |
Replication/IConcertClientReplicationManager.h | ||
TSet< FGuid > GetClientOwnedStreamsForObject
(
const FSoftObjectPath& ObjectPath |
Replication/IConcertClientReplicationManager.h | ||
TArray< FConcertReplicationStream > GetRegisteredStreams() |
Replication/IConcertClientReplicationManager.h | ||
TSet< FConcertObjectInStreamID > GetSyncControlledObjects() |
Util for converting all sync controlled objects into a TSet. | Replication/IConcertClientReplicationManager.h | |
bool HasAuthorityOver
(
const FSoftObjectPath& ObjectPath |
Replication/IConcertClientReplicationManager.h | ||
bool HasRegisteredStreams() |
Replication/IConcertClientReplicationManager.h | ||
bool HasSyncControl
(
const FConcertObjectInStreamID& Object |
Replication/IConcertClientReplicationManager.h | ||
bool IsConnectedToReplicationSession() |
Whether JoinReplicationSession completed successfully and LeaveReplicationSession has not yet been called. | Replication/IConcertClientReplicationManager.h | |
| Joins a replication session. | Replication/IConcertClientReplicationManager.h | ||
void LeaveReplicationSession() |
Leaves the current replication session. | Replication/IConcertClientReplicationManager.h | |
TFuture< FConcertReplication_ChangeMuteState_Response > MuteObjects
(
TConstArrayView< FSoftObjectPath > Objects, |
Util function that will mute all of Objects. | Replication/IConcertClientReplicationManager.h | |
uint32 NumSyncControlledObjects() |
Replication/IConcertClientReplicationManager.h | ||
FOnPostAuthorityChanged & OnPostAuthorityChanged() |
Called right after GetClientOwnedObjects has changed. | Replication/IConcertClientReplicationManager.h | |
FOnRemoteEditApplied & OnPostRemoteEditApplied () |
Called after updating any local state in response to the server notifying us that the local client's content was remotely edited. | Replication/IConcertClientReplicationManager.h | |
FOnPostStreamsChanged & OnPostStreamsChanged() |
Called right after the result of GetRegisteredStreams has changed. | Replication/IConcertClientReplicationManager.h | |
FSyncControlChanged & OnPostSyncControlChanged() |
Called just after sync control change is applied. | Replication/IConcertClientReplicationManager.h | |
FOnPreAuthorityChanged & OnPreAuthorityChanged() |
Called right before GetClientOwnedObjects changes. | Replication/IConcertClientReplicationManager.h | |
FOnRemoteEditApplied & OnPreRemoteEditApplied () |
Called before updating any local state in response to the server notifying us that the local client's content was remotely edited. | Replication/IConcertClientReplicationManager.h | |
FOnPreStreamsChanged & OnPreStreamsChanged() |
Called right before the result of GetRegisteredStreams changes. | Replication/IConcertClientReplicationManager.h | |
FSyncControlChanged & OnPreSyncControlChanged() |
Called just before sync control change is applied. | Replication/IConcertClientReplicationManager.h | |
| Changes multiple clients' stream, authority, and optionally the global mute state. | Replication/IConcertClientReplicationManager.h | ||
| Requests replication info about other clients, including the streams registered and which objects they have authority over (i.e. are sending). | Replication/IConcertClientReplicationManager.h | ||
| Gets the global mute state. | Replication/IConcertClientReplicationManager.h | ||
TFuture< FConcertReplication_QueryMuteState_Response > QueryMuteState
(
TSet< FSoftObjectPath > Objects |
Replication/IConcertClientReplicationManager.h | ||
TFuture< FConcertReplication_ChangeAuthority_Response > ReleaseAuthorityOf
(
TConstArrayView< FSoftObjectPath > Objects |
Util function that will let go over all authority of the given objects. | Replication/IConcertClientReplicationManager.h | |
| Requests from the server to change the authority over some objects. | Replication/IConcertClientReplicationManager.h | ||
| Restore this client's stream content and authority to what a client had when they left. | Replication/IConcertClientReplicationManager.h | ||
TFuture< FConcertReplication_ChangeAuthority_Response > TakeAuthorityOver
(
TConstArrayView< FSoftObjectPath > Objects |
Util function that will request authority for all streams for the given objects. | Replication/IConcertClientReplicationManager.h | |
TFuture< FConcertReplication_ChangeMuteState_Response > UnmuteObjects
(
TSet< FSoftObjectPath > Objects, |
Util function that will unmute all of Objects. | Replication/IConcertClientReplicationManager.h |