FConcertReplication_ChangeMuteState_Request

Navigation

API > API/Plugins > API/Plugins/ConcertSyncCore

A request to globally pause / resume replication of objects. Muted objects will not be replicated to any clients. For security reasons, muting is only available in sessions with the EConcertSyncSessionFlags::ShouldAllowGlobalMuting flag set.

If a muted objects is unregistered (i.e. by a stream change request), the mute state is also removed. That the object is later re-registered, it will not be muted.

Requests are processed atomically: it is completed either completely or not at all. The following operations are invalid:

• Unmuting / muting an object without the IncludeSubobjects flag if that object is not registered in any stream.
• Unmuting / muting an object with the IncludeSubobjects flag if that object is not registered in any stream, and that object has no subobjects registered in any streams. The reason for making these operations invalid is to prevent memory leaks on the server (e.g. client unregisters an object and forgets to remove the mute state, too). The following operations are valid:
• Unmuting an object that is already unmuted (no-op)
• Muting an object that is already muted (no-op); changing the EConcertReplicationMuteFlags is not a no-op.

Sync control: This request may update sync control. The following rules apply:

• This request may cause FConcertReplication_ChangeSyncControl events to be sent to OTHER clients.
• This request will NOT cause any FConcertReplication_ChangeSyncControl event to be sent to the requesting client:
• When muting, the requesting client is expected to infer that sync control is lost for the muted objects.
• When unmuting, the server fills FConcertReplication_ChangeMuteState_Response::SyncControl with the object the requesting client has received sync control over.

Syntax

USTRUCT ()  
struct FConcertReplication_ChangeMuteState_Request  
Copy full snippet

USTRUCT () struct FConcertReplication_ChangeMuteState_Request

Variables

Public

Functions

Public