EventLoopIOAccessBSDSocket.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
 
#if PLATFORM_HAS_BSD_SOCKETS
 
#include "Containers/UnrealString.h"
#include "EventLoop/BSDSocket/BSDSocketTypes.h"
#include "EventLoop/IEventLoopIOManager.h"
#include "EventLoop/EventLoopManagedStorage.h"
#include "Templates/Function.h"
 
namespace UE::EventLoop {
 
enum class ESocketIoRequestStatus : uint8
{
    Ok,
 
    NoResources,
 
    Invalid,
};
 
using FSocketIOCallback = TUniqueFunction<void(SOCKET Socket, ESocketIoRequestStatus Status, EIOFlags SignaledFlags)>;
using FSocketIORequestDestroyedCallback = FManagedStorageOnRemoveComplete;
 
struct FIORequestBSDSocket
{
    SOCKET Socket = INVALID_SOCKET;
    EIOFlags Flags = EIOFlags::None;
    FSocketIOCallback Callback;
};
 
class FIOAccessBSDSocket final : public FNoncopyable
{
public:
    struct FStorageTraits : public FManagedStorageDefaultTraits
    {
        using FExternalHandle = FIORequestHandle;
    };
 
    using FStorageType = TManagedStorage<FIORequestBSDSocket, FStorageTraits>;
 
    FIOAccessBSDSocket(FStorageType& InIORequestStorage)
        : IORequestStorage(InIORequestStorage)
    {
    }
 
    FIORequestHandle CreateSocketIORequest(FIORequestBSDSocket&& Request)
    {
        if (Request.Socket == INVALID_SOCKET || Request.Flags == EIOFlags::None || !Request.Callback)
        {
            return FIORequestHandle();
        }
 
        return IORequestStorage.Add({MoveTemp(Request)});
    }
 
    void DestroyIORequest(FIORequestHandle& Handle, FSocketIORequestDestroyedCallback&& OnDestroyComplete = FSocketIORequestDestroyedCallback())
    {
        IORequestStorage.Remove(Handle, MoveTemp(OnDestroyComplete));
    }
 
private:
    FStorageType& IORequestStorage;
};
 
/* UE::EventLoop */ }
 
inline FString LexToString(UE::EventLoop::ESocketIoRequestStatus Status)
{
    switch (Status)
    {
    case UE::EventLoop::ESocketIoRequestStatus::Ok: return TEXT("Ok");
    case UE::EventLoop::ESocketIoRequestStatus::NoResources: return TEXT("NoResources");
    case UE::EventLoop::ESocketIoRequestStatus::Invalid: return TEXT("Invalid");
 
    default:
        checkNoEntry();
        return TEXT("Unknown");
    }
}
 
#endif // PLATFORM_HAS_BSD_SOCKETS