FRecvMulti Struct Reference

#include <SocketTypes.h>

Inheritance diagram for FRecvMulti:

Public Member Functions
void	GetPacket (int32 PacketIdx, FReceivedPacketView &OutPacket)
virtual bool	GetPacketTimestamp (int32 PacketIdx, FPacketTimestamp &OutTimestamp) const =0
int32	GetNumPackets () const
virtual SOCKETS_API void	CountBytes (FArchive &Ar) const
Public Member Functions inherited from FVirtualDestructor
virtual	~FVirtualDestructor ()

Public Attributes
const int32	MaxNumPackets
const int32	MaxPacketSize

Friends
struct	FUnixRecvMulti
class	FSocketUnix

Additional Inherited Members
Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()
	~FNoncopyable ()

Detailed Description

Stores the persistent state and packet buffers/data, for receiving packets with FSocket::RecvMulti. To optimize performance, use only once instance of this struct, for the lifetime of the socket.

Member Function Documentation

CountBytes()

void FRecvMulti::CountBytes ( FArchive &  Ar ) const

virtual

Calculates the total memory consumption of this FRecvMulti instance, including platform-specific data

Parameters

Ar	The archive being used to count the memory consumption

GetNumPackets()

int32 FRecvMulti::GetNumPackets ( ) const

inline

Retrieves the current number of received packets

GetPacket()

void FRecvMulti::GetPacket ( int32  PacketIdx, FReceivedPacketView &  OutPacket  )

inline

Retrieves the information for the specified packet

Parameters

PacketIdx	The RecvMulti index for the packet to be retrieved
OutPacket	Outputs a view to the received packet

GetPacketTimestamp()

virtual bool FRecvMulti::GetPacketTimestamp ( int32  PacketIdx, FPacketTimestamp &  OutTimestamp  ) const

pure virtual

Returns the platform specific timestamp for when the specified packet was received by the operating system

Parameters

PacketIdx	The index into Packets, of the packet to be checked
OutTimestamp	The timestamp for the specified packet

Returns

Whether or not the timestamp was retrieved successfully

Friends And Related Symbol Documentation

FSocketUnix

friend class FSocketUnix

friend

FUnixRecvMulti

friend struct FUnixRecvMulti

friend

Member Data Documentation

MaxNumPackets

const int32 FRecvMulti::MaxNumPackets

The maximum number of packets this FRecvMulti instance can support

MaxPacketSize

const int32 FRecvMulti::MaxPacketSize

The maximum packet size this FRecvMulti instance can support

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Sockets/Public/SocketTypes.h
• Engine/Source/Runtime/Sockets/Private/Sockets.cpp