StageMessages.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
 
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/Guid.h"
#include "Misc/QualifiedFrameTime.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectMacros.h"
 
#include "StageMessages.generated.h"
 
#define ENABLE_STAGEMONITOR_LOGGING (1 && !NO_LOGGING && !(UE_BUILD_SHIPPING || UE_BUILD_TEST))
 
 
UENUM()
enum class EStageMessageFlags : uint8
{
    None = 0,
 
    Reliable = 1 << 0,
};
ENUM_CLASS_FLAGS(EStageMessageFlags);
 
UENUM()
enum class EStageDataProviderState : uint8
{
    Active,
    Inactive,
    Closed,
};
 
 
UENUM()
enum class EStageCriticalStateEvent : uint8
{
    Enter,
    Exit,
};
 
UENUM()
enum class EStageLoadingState : uint8
{
    PreLoad,
    PostLoad
};
 
USTRUCT()
struct STAGEDATACORE_API FStageInstanceDescriptor
{
    GENERATED_BODY()
 
public:
 
public:
 
    UPROPERTY()
    FString MachineName;
 
    UPROPERTY()
    uint32 ProcessId = 0;
    
    UPROPERTY()
    FString RolesStringified;
 
    UPROPERTY()
    FName FriendlyName;
 
    UPROPERTY()
    int32 SessionId = INDEX_NONE;
};
 
USTRUCT()
struct STAGEDATACORE_API FStageDataBaseMessage
{
    GENERATED_BODY()
 
public:
    virtual ~FStageDataBaseMessage() = default;
    
public:
 
    UPROPERTY()
    int32 StageMessageVersion = 1;
 
    UPROPERTY()
    FGuid Identifier;
};
 
USTRUCT()
struct STAGEDATACORE_API FStageMonitorBaseMessage : public FStageDataBaseMessage
{
    GENERATED_BODY()
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderDiscoveryMessage : public FStageMonitorBaseMessage
{
    GENERATED_BODY()
 
public:
    FStageProviderDiscoveryMessage() = default;
    FStageProviderDiscoveryMessage(FStageInstanceDescriptor&& InDescriptor)
        : Descriptor(MoveTemp(InDescriptor))
        {}
 
public:
 
    UPROPERTY()
    FStageInstanceDescriptor Descriptor;
};
 
USTRUCT()
struct STAGEDATACORE_API FStageMonitorCloseMessage : public FStageMonitorBaseMessage
{
    GENERATED_BODY()
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderMessage : public FStageDataBaseMessage
{
    GENERATED_BODY()
 
public:
    virtual FString ToString() const { return FString(); }
 
public:
    
    UPROPERTY()
    FQualifiedFrameTime FrameTime;
 
    UPROPERTY()
    FDateTime DateTime;
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderEventMessage : public FStageProviderMessage
{
    GENERATED_BODY()
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderPeriodicMessage : public FStageProviderMessage
{
    GENERATED_BODY()
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderCloseMessage : public FStageProviderEventMessage
{
    GENERATED_BODY()
};
 
USTRUCT()
struct STAGEDATACORE_API FStageProviderDiscoveryResponseMessage : public FStageProviderEventMessage
{
    GENERATED_BODY()
    
public:
    FStageProviderDiscoveryResponseMessage() = default;
    FStageProviderDiscoveryResponseMessage(FStageInstanceDescriptor&& InDescriptor)
        : Descriptor(MoveTemp(InDescriptor))
        {}
 
 
public:
 
    UPROPERTY()
    FStageInstanceDescriptor Descriptor;
};
 
USTRUCT()
struct STAGEDATACORE_API FCriticalStateProviderMessage : public FStageProviderEventMessage
{
    GENERATED_BODY()
 
public:
 
    FCriticalStateProviderMessage() = default;
 
    FCriticalStateProviderMessage(EStageCriticalStateEvent InEvent, FName InSourceName)
        : State(InEvent), SourceName(InSourceName)
    {
    }
 
    virtual FString ToString() const override;
 
    UPROPERTY(VisibleAnywhere, Category = "CriticalState")
    EStageCriticalStateEvent State = EStageCriticalStateEvent::Enter;
 
    UPROPERTY(VisibleAnywhere, Category = "CriticalState")
    FName SourceName;
};
 
USTRUCT()
struct STAGEDATACORE_API FAssetLoadingStateProviderMessage : public FStageProviderEventMessage
{
    GENERATED_BODY()
 
public:
    FAssetLoadingStateProviderMessage() = default;
 
    FAssetLoadingStateProviderMessage(EStageLoadingState InState, const FString& InAssetName)
        : LoadingState(InState), AssetName(InAssetName)
    {}
 
    virtual FString ToString() const override;
 
    UPROPERTY(VisibleAnywhere, Category = "AssetLoading")
    EStageLoadingState LoadingState = EStageLoadingState::PreLoad;
 
    UPROPERTY(VisibleAnywhere, Category = "AssetLoading")
    FString AssetName;
};