IMessageContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Async/TaskGraphInterfaces.h"
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Misc/Crc.h"
#include "Misc/Guid.h"
#include "Templates/SharedPointer.h"
#include "UObject/Class.h"
#include "UObject/NameTypes.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
class IMessageAttachment;
 
struct FDateTime;
 
 
struct FMessageAddress
{
public:
 
    FMessageAddress() { }
 
public:
 
    friend bool operator==(const FMessageAddress& X, const FMessageAddress& Y)
    {
        return (X.UniqueId == Y.UniqueId);
    }
 
    friend bool operator!=(const FMessageAddress& X, const FMessageAddress& Y)
    {
        return (X.UniqueId != Y.UniqueId);
    }
 
    friend FArchive& operator<<(FArchive& Ar, FMessageAddress& A)
    {
        return Ar << A.UniqueId;
    }
 
public:
 
    void Invalidate()
    {
        UniqueId.Invalidate();
    }
 
    bool IsValid() const
    {
        return UniqueId.IsValid();
    }
 
    FString ToString() const
    {
        return UniqueId.ToString();
    }
 
public:
 
    friend uint32 GetTypeHash(const FMessageAddress& Address)
    {
        return FCrc::MemCrc_DEPRECATED(&Address.UniqueId, sizeof(FGuid));
    }
 
public:
 
    static FMessageAddress NewAddress()
    {
        FMessageAddress Result;
        Result.UniqueId = FGuid::NewGuid();
 
        return Result;
    }
 
    static bool Parse(const FString& String, FMessageAddress& OutAddress)
    {
        return FGuid::Parse(String, OutAddress.UniqueId);
    }
 
private:
 
    FGuid UniqueId;
};
 
 
enum class EMessageScope : uint8
{
    Thread,
 
    Process,
 
    Network,
 
    All
};
 
enum class EMessageFlags : uint32
{
    None = 0,
        
    Reliable = 1 << 0,
        
    Traced = 1 << 1
};
ENUM_CLASS_FLAGS(EMessageFlags);
 
 
typedef TRange<EMessageScope> FMessageScopeRange;
 
typedef TRangeBound<EMessageScope> FMessageScopeRangeBound;
 
 
class IMessageContext
{
public:
 
    virtual const TMap<FName, FString>& GetAnnotations() const = 0;
 
    virtual TSharedPtr<IMessageAttachment, ESPMode::ThreadSafe> GetAttachment() const = 0;
 
    virtual const FDateTime& GetExpiration() const = 0;
 
    virtual const void* GetMessage() const = 0;
 
    virtual const TWeakObjectPtr<UScriptStruct>& GetMessageTypeInfo() const = 0;
 
    virtual TSharedPtr<IMessageContext, ESPMode::ThreadSafe> GetOriginalContext() const = 0;
 
    virtual const TArray<FMessageAddress>& GetRecipients() const = 0;
 
    virtual EMessageScope GetScope() const = 0;
 
    virtual EMessageFlags GetFlags() const = 0;
 
    virtual const FMessageAddress& GetSender() const = 0;
 
    virtual const FMessageAddress& GetForwarder() const = 0;
    
    virtual ENamedThreads::Type GetSenderThread() const = 0;
 
    virtual const FDateTime& GetTimeForwarded() const = 0;
 
    virtual const FDateTime& GetTimeSent() const = 0;
 
public:
 
    UE_DEPRECATED(5.1, "Type names are now represented by path names. Please use GetMessageTypePathName.")
    FName GetMessageType() const
    {
        if (IsValid())
        {
            UStruct* MessageTypeInfoPtr = GetMessageTypeInfo().Get();
            return MessageTypeInfoPtr->GetFName();
        }
        
        return NAME_None;
    }
 
    FTopLevelAssetPath GetMessageTypePathName() const
    {
        if (IsValid())
        {
            UStruct* MessageTypeInfoPtr = GetMessageTypeInfo().Get();
            return MessageTypeInfoPtr->GetStructPathName();
        }
 
        return FTopLevelAssetPath();
    }
 
    bool IsForwarded() const
    {
        return GetOriginalContext().IsValid();
    }
 
    bool IsValid() const
    {
        return ((GetMessage() != nullptr) && GetMessageTypeInfo().IsValid(false, true));
    }
 
public:
 
    virtual ~IMessageContext() { }
};