Navigation
API > API/Plugins > API/Plugins/ConcertSyncCore
Holds on to events received from remote endpoints and exposes them as a source.
Received events are received from a FObjectReplicationCache, which makes sure that event data is shared effectively if you created multiple FReplicationDataQueuer based on the same cache. This is relevant server side, where a FReplicationDataQueuer is created for each client.
Child classes need to implement IReplicationCacheUser::WantsToAcceptObject. TODO: Remove object data if the object is is meant for becomes unavailable.
| Name | FReplicationDataQueuer |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/Replication/Processing/ReplicationDataQueuer.h |
| Include Path | #include "Replication/Processing/ReplicationDataQueuer.h" |
Syntax
class FReplicationDataQueuer :
public UE::ConcertSyncCore::IReplicationDataSource ,
public UE::ConcertSyncCore::IReplicationCacheUser ,
public TSharedFromThis< FReplicationDataQueuer >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FReplicationDataQueuer
Structs
| Name | Remarks |
|---|---|
| FPendingObjectData |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PendingEvents | TMap< FConcertReplicatedObjectId, FPendingObjectData > | Stores events as they are received. | Replication/Processing/ReplicationDataQueuer.h | |
| ReplicationCache | FObjectReplicationCache * | Provides us with replication events and shares them effectively. | Replication/Processing/ReplicationDataQueuer.h |
Functions
Public
Overridden from IReplicationDataSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ExtractReplicationDataForObject
(
const FConcertReplicatedObjectId& Object, |
Extracts data for Object. | Replication/Processing/ReplicationDataQueuer.h | |
virtual void ForEachPendingObject
(
TFunctionRef< void(const FPendingObjectReplicationInfo&)> ProcessItemFunc |
Iterates the objects that must be processed for replication (the result of ExtractReplicationDataForObject MAY return something new). | Replication/Processing/ReplicationDataQueuer.h | |
virtual int32 NumObjects() |
Replication/Processing/ReplicationDataQueuer.h |
Overridden from IReplicationCacheUser
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnCachedDataUpdated
(
const FConcertReplicatedObjectId& Object, |
This function is called when new data is received while this cache user is still holding on to an object previously received with OnDataCached. | Replication/Processing/ReplicationDataQueuer.h | |
virtual void OnDataCached
(
const FConcertReplicatedObjectId& Object, |
Called when data that is interesting to this user becomes available. | Replication/Processing/ReplicationDataQueuer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BindToCache
(
FObjectReplicationCache& InReplicationCache |
Called by subclass factory functions. | Replication/Processing/ReplicationDataQueuer.h |