PacketView.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Net/Common/Sockets/SocketErrors.h"
#include "Net/Common/Packets/PacketTraits.h"
 
 
// Forward declarations
class FInternetAddr;
 
 
struct FPacketBufferView
{
    const TArrayView<uint8>     Buffer;
 
 
    FPacketBufferView(uint8* InData, int32 MaxBufferSize)
        : Buffer(MakeArrayView<uint8>(InData, MaxBufferSize))
    {
    }
};
 
namespace ECountUnits
{
    enum BitType
    {
        Bits
    };
 
    enum ByteType
    {
        Bytes
    };
}
 
class FPacketDataView
{
    friend struct FReceivedPacketView;
 
private:
    TArrayView<const uint8> Data;
 
    int32 CountBits;
 
public:
    FPacketDataView(const uint8* InData, int32 InCountBits, ECountUnits::BitType)
        : Data(MakeArrayView(InData, FMath::DivideAndRoundUp(InCountBits, 8)))
        , CountBits(InCountBits)
    {
    }
 
    FPacketDataView(const uint8* InData, int32 InCountBytes, ECountUnits::ByteType)
        : Data(MakeArrayView(InData, InCountBytes))
        , CountBits(InCountBytes * 8)
    {
    }
 
    const uint8* GetData() const
    {
        return Data.GetData();
    }
 
    // @todo: Remove this when the PacketHandler code is updated
    uint8* GetMutableData() const
    {
        return const_cast<uint8*>(Data.GetData());
    }
 
    int32 NumBits() const
    {
        return CountBits;
    }
 
    int32 NumBytes() const
    {
        return Data.Num();
    }
};
 
 
struct FReceivedPacketView
{
    FPacketDataView                     DataView = {nullptr, 0, ECountUnits::Bits};
 
    // @todo: When removing deprecation, remove FReceivedPacketView's friend access to FPacketDataView
    UE_DEPRECATED(4.26, "Data is deprecated, use DataView instead")
    TArrayView<const uint8>&            Data = DataView.Data;
 
    TSharedPtr<const FInternetAddr>     Address;
 
    ESocketErrors                       Error;
 
    FInPacketTraits                     Traits;
};
 
struct FPacketTimestamp
{
    FTimespan   Timestamp;
};