NetResultManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "HAL/Platform.h"
#include "Net/Core/Connection/NetResult.h"
#include "Templates/Function.h"
#include "Templates/UniquePtr.h"
 
 
namespace UE
{
namespace Net
{
 
// Forward declarations
class FNetResultHandler;
 
 
enum class EHandleNetResult : uint8
{
    Closed,         // The connection was closed (certain code paths should return early)
    Handled,        // The result was handled, but (if a fault) has not yet resulted in a connection Close
    NotHandled      // The result was not handled (no result handler or 'unhandled result' callback handled it)
};
 
enum class EAddResultHandlerPos : uint8
{
    First,          // Places the new handler at the start of the list (higher precedence)
    Last            // Places the new handler at the end of the list (lower precedence)
};
 
 
class FNetResultManager final
{
public:
    using FUnhandledResultFunc = TUniqueFunction<EHandleNetResult(FNetResult&& InResult)>;
 
 
public:
    FNetResultManager() = default;
 
    FNetResultManager(FNetResultManager&) = delete;
    FNetResultManager& operator=(const FNetResultManager&) = delete;
    FNetResultManager(FNetResultManager&&) = delete;
    FNetResultManager& operator=(FNetResultManager&&) = delete;
 
    NETCORE_API void AddResultHandler(TUniquePtr<FNetResultHandler>&& InResultHandler, EAddResultHandlerPos Position=EAddResultHandlerPos::Last);
 
    NETCORE_API void AddResultHandlerPtr(FNetResultHandler* InResultHandler, EAddResultHandlerPos Position=EAddResultHandlerPos::Last);
 
    NETCORE_API EHandleNetResult HandleNetResult(FNetResult&& InResult);
 
    NETCORE_API void SetUnhandledResultCallback(FUnhandledResultFunc InCallback);
 
private:
    TArray<FNetResultHandler*, TInlineAllocator<8>> ResultHandlers;
 
    TArray<TUniquePtr<FNetResultHandler>> OwnedResultHandlers;
 
    FUnhandledResultFunc UnhandledResultCallback;
};
 
 
class FNetResultHandler
{
    friend FNetResultManager;
 
public:
    FNetResultHandler() = default;
    virtual ~FNetResultHandler() = default;
 
    FNetResultHandler(const FNetResultHandler&) = delete;
    FNetResultHandler& operator=(const FNetResultHandler&) = delete;
    FNetResultHandler(FNetResultHandler&&) = delete;
    FNetResultHandler& operator=(FNetResultHandler&&) = delete;
 
 
    virtual void Init()
    {
    }
 
    virtual EHandleNetResult HandleNetResult(FNetResult&& InCloseResult)
    {
        return EHandleNetResult::NotHandled;
    }
 
protected:
    FNetResultManager* ResultManager = nullptr;
};
 
}
}