SocketTypes.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Net/Common/Packets/PacketView.h"
 
// Forward declarations
class FInternetAddr;
class ISocketSubsystem;
class FSocket;
 
 
enum class ESocketProtocolFamily : uint8
{
    None,
    IPv4,
    IPv6
};
 
namespace FNetworkProtocolTypes
{
    SOCKETS_API extern const FLazyName IPv4;
    SOCKETS_API extern const FLazyName IPv6;
}
 
enum ESocketType
{
    SOCKTYPE_Unknown,
    SOCKTYPE_Datagram,
    SOCKTYPE_Streaming
};
 
enum ESocketConnectionState
{
    SCS_NotConnected,
    SCS_Connected,
    SCS_ConnectionError
};
 
 
namespace ESocketReceiveFlags
{
    enum Type
    {
        None = 0,
 
        Peek = 2,
 
        WaitAll = 0x100
    };
}
 
 
namespace ESocketWaitConditions
{
    enum Type
    {
        WaitForRead,
 
        WaitForWrite,
 
        WaitForReadOrWrite
    };
}
 
enum class ESocketShutdownMode
{
    Read,
    
    Write,
    
    ReadWrite
};
 
 
 
 
enum class ETimestampTranslation : uint8
{
    LocalTimestamp,
 
    TimeDelta
};
 
enum class ERecvMultiFlags : uint32
{
    None                = 0x00000000,
    RetrieveTimestamps  = 0x00000001    // Whether or not to support retrieving timestamps
};
 
ENUM_CLASS_FLAGS(ERecvMultiFlags);
 
 
struct FRecvMulti : public FNoncopyable, public FVirtualDestructor
{
    friend struct FUnixRecvMulti;
    friend class FSocketUnix;
 
private:
    struct FRecvData
    {
        TSharedPtr<FInternetAddr>   Source;
 
        const uint8*                Data;
 
        const uint32*               BytesReadPtr;
 
 
        FRecvData()
            : Source()
            , Data(nullptr)
            , BytesReadPtr(nullptr)
        {
        }
    };
 
 
private:
    TUniquePtr<FRecvData[]>         Packets;
 
    int32                           NumPackets;
 
public:
    const int32                     MaxNumPackets;
 
    const int32                     MaxPacketSize;
 
 
private:
    SOCKETS_API FRecvMulti(ISocketSubsystem* SocketSubsystem, int32 InMaxNumPackets, int32 InMaxPacketSize,
                ERecvMultiFlags InitFlags=ERecvMultiFlags::None);
 
 
public:
    void GetPacket(int32 PacketIdx, FReceivedPacketView& OutPacket)
    {
        check(PacketIdx >= 0);
        check(PacketIdx < NumPackets);
 
        FRecvData& CurData = Packets.Get()[PacketIdx];
 
        OutPacket.DataView = {CurData.Data, (int32)*CurData.BytesReadPtr, ECountUnits::Bytes};
        OutPacket.Address = CurData.Source;
        OutPacket.Error = ESocketErrors::SE_NO_ERROR;
    }
 
    virtual bool GetPacketTimestamp(int32 PacketIdx, FPacketTimestamp& OutTimestamp) const = 0;
 
    int32 GetNumPackets() const
    {
        return NumPackets;
    }
 
 
    SOCKETS_API virtual void CountBytes(FArchive& Ar) const;
};