RemoteObjectTransfer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
#include "UObject/RemoteObjectPathName.h"
#include "Async/Async.h"
#include "UObject/RemoteExecutor.h"
 
namespace UE::Net
{
    struct FRemoteObjectReferenceNetSerializer;
}
 
struct FUObjectMigrationContext;
 
struct FRemoteObjectBytes
{
    TArray<uint8> Bytes;
};
 
struct FRemoteObjectData
{
    FRemoteObjectTables Tables;
    TArray<FPackedRemoteObjectPathName> PathNames;
    TArray<FRemoteObjectBytes> Bytes;
 
    inline int32 GetNumBytes() const
    {
        int32 Num = 0;
        for (const FRemoteObjectBytes& Chunk : Bytes)
        {
            Num += Chunk.Bytes.Num();
        }
        return Num;
    }
};
 
namespace UE::RemoteObject::Transfer
{
    struct FMigrateSendParams
    {
        FUObjectMigrationContext& MigrationContext;
 
        FRemoteObjectData ObjectData;
    };
 
    COREUOBJECT_API void OnObjectDataReceived(FRemoteServerId OwnerServerId, FRemoteServerId PhysicsId, uint32 PhysicsLocalIslandId, FRemoteObjectId ObjectId, FRemoteServerId RemoteServerId, FRemoteObjectData& Data);
 
    COREUOBJECT_API void OnObjectDataDenied(FRemoteObjectId ObjectId, FRemoteServerId RemoteServerId);
 
    COREUOBJECT_API void TransferObjectOwnershipToRemoteServer(UObject* Object, FRemoteServerId DestinationServerId);
 
    COREUOBJECT_API void MigrateObjectToRemoteServer(FRemoteObjectId ObjectId, FRemoteServerId DestinationServerId);
    COREUOBJECT_API void MigrateObjectToRemoteServerWithExplicitPriority(FRemoteWorkPriority RequestPriority, FRemoteObjectId Id, FRemoteServerId DestinationServerId);
    
    COREUOBJECT_API void MigrateObjectFromRemoteServer(FRemoteObjectId ObjectId, FRemoteServerId CurrentOwnerServerId, UObject* DestinationOuter = nullptr);
 
    COREUOBJECT_API void TouchResidentObject(UObject* Object);
 
    UE_DEPRECATED(5.6, "RemoteObjectIdToObjectPtr is deprecated use FObjectPtr(FRemoteObjectId) instead.")
    UE_FORCEINLINE_HINT FObjectPtr RemoteObjectIdToObjectPtr(FRemoteObjectId RemoteId)
    {
#if UE_WITH_REMOTE_OBJECT_HANDLE
        return FObjectPtr(UE::CoreUObject::Private::FRemoteObjectHandlePrivate::FromIdNoResolve(RemoteId));
#else
        return FObjectPtr();
#endif
    }
 
    COREUOBJECT_API void RegisterRemoteObjectId(FRemoteObjectId Id, FRemoteServerId ResidentServerId);
 
    COREUOBJECT_API void GetAllBorrowedObjects(TArray<FRemoteObjectId>& OutBorrowedObjectIds);
 
    COREUOBJECT_API void RegisterSharedObject(UObject* Object);
 
    extern COREUOBJECT_API const FRemoteServerId DatabaseId;
 
    COREUOBJECT_API void InitRemoteObjectTransfer();
 
    extern COREUOBJECT_API TDelegate<void(const FMigrateSendParams& /*Params*/)> RemoteObjectTransferDelegate;
 
    extern COREUOBJECT_API TDelegate<void(FRemoteObjectId /*ObjectId*/, FRemoteServerId /*DestinationServerId*/)> RemoteObjectDeniedTransferDelegate;
 
    extern COREUOBJECT_API TDelegate<void(FRemoteWorkPriority /*RequestPriority*/, FRemoteObjectId /*ObjectId*/, FRemoteServerId /*LastKnownResidentServerId*/, FRemoteServerId /*DestinationServerId*/)> RequestRemoteObjectDelegate;
 
    extern COREUOBJECT_API TMulticastDelegate<void(const FRemoteObjectData& /*ObjectData*/, const FUObjectMigrationContext& /*MigrationContext*/)> OnObjectDataReceivedDelegate;
 
    extern COREUOBJECT_API TMulticastDelegate<void(const TArray<UObject*>& /*MigratedObjects*/, const FUObjectMigrationContext& /*MigrationContext*/)> OnObjectsReceivedDelegate;
 
    extern COREUOBJECT_API TMulticastDelegate<void(const FRemoteObjectData& /*ObjectData*/, const FUObjectMigrationContext& /*MigrationContext*/)> OnObjectDataSentDelegate;
 
    extern COREUOBJECT_API TMulticastDelegate<void(const TSet<UObject*>& /*MigratedObjects*/, const FUObjectMigrationContext& /*MigrationContext*/)> OnObjectsSentDelegate;
 
    extern COREUOBJECT_API TMulticastDelegate<void(FRemoteTransactionId /*RequestId*/, FRemoteObjectId /*ObjectId*/)> OnObjectTouchedDelegate;
 
    extern COREUOBJECT_API TDelegate<void(const FMigrateSendParams&)> StoreRemoteObjectDataDelegate;
 
    extern COREUOBJECT_API TDelegate<void(const FUObjectMigrationContext&)> RestoreRemoteObjectDataDelegate;
 
} // namespace UE::RemoveObject::Transfer
 
struct FRemoteObjectReference
{
private:
    FRemoteObjectId ObjectId;
    FRemoteServerId ServerId;
 
public:
    FRemoteObjectReference() = default;
 
    FRemoteObjectReference(const FRemoteObjectReference&) = default;
    FRemoteObjectReference& operator=(const FRemoteObjectReference&) = default;
 
    COREUOBJECT_API explicit FRemoteObjectReference(const FObjectPtr& Ptr);
 
    template <typename T>
    explicit FRemoteObjectReference(const TObjectPtr<T>& Ptr)
        : FRemoteObjectReference(FObjectPtr(Ptr.GetHandle()))
    {
    }
 
    COREUOBJECT_API explicit FRemoteObjectReference(const FWeakObjectPtr& WeakPtr);
 
    template <typename T>
    explicit FRemoteObjectReference(const TWeakObjectPtr<T>& WeakPtr)
        : FRemoteObjectReference((FWeakObjectPtr)WeakPtr)
    {
    }
 
    UE_FORCEINLINE_HINT bool operator==(const FRemoteObjectReference& Other) const
    {
        return ObjectId == Other.ObjectId;
    }
 
    COREUOBJECT_API FObjectPtr ToObjectPtr() const;
    COREUOBJECT_API FWeakObjectPtr ToWeakPtr() const;
    COREUOBJECT_API UObject* Resolve() const;
 
    UE_FORCEINLINE_HINT FRemoteObjectId GetRemoteId() const
    {
        return ObjectId;
    }
    UE_FORCEINLINE_HINT FRemoteServerId GetSharingServerId() const
    {
        return ServerId;
    }
    UE_FORCEINLINE_HINT bool IsRemote() const
    {
        return UE::RemoteObject::Handle::IsRemote(ObjectId);
    }
 
    COREUOBJECT_API bool Serialize(FArchive& Ar);
    COREUOBJECT_API bool NetSerialize(FArchive& Ar, class UPackageMap* Map, bool& bOutSuccess);
 
    friend FArchive& operator<<(FArchive& Ar, FRemoteObjectReference& Ref);
 
private:
    friend struct UE::Net::FRemoteObjectReferenceNetSerializer;
    COREUOBJECT_API void NetDequantize(FRemoteObjectId InObjectId, FRemoteServerId InServerId, const FRemoteObjectPathName& InPath);
};
 
template<>
struct TStructOpsTypeTraits<FRemoteObjectReference> : public TStructOpsTypeTraitsBase2<FRemoteObjectReference>
{
    enum
    {
        WithNetSerializer = true,
        WithSerializer = true,
    };
};
 
inline FArchive& operator<<(FArchive& Ar, FRemoteObjectReference& Ref)
{
    Ref.Serialize(Ar);
    return Ar;
}