SocketTypes.h File Reference

#include "CoreMinimal.h"
#include "Net/Common/Packets/PacketView.h"

Go to the source code of this file.

Classes
struct	FRecvMulti

Namespaces
namespace	FNetworkProtocolTypes
namespace	ESocketReceiveFlags
namespace	ESocketWaitConditions

Enumerations
enum class	ESocketProtocolFamily : uint8 { None , IPv4 , IPv6 }
enum	ESocketType { SOCKTYPE_Unknown , SOCKTYPE_Datagram , SOCKTYPE_Streaming }
enum	ESocketConnectionState { SCS_NotConnected , SCS_Connected , SCS_ConnectionError }
enum	ESocketReceiveFlags::Type { ESocketReceiveFlags::None = 0 , ESocketReceiveFlags::Peek = 2 , ESocketReceiveFlags::WaitAll = 0x100 }
enum	ESocketWaitConditions::Type { ESocketWaitConditions::WaitForRead , ESocketWaitConditions::WaitForWrite , ESocketWaitConditions::WaitForReadOrWrite }
enum class	ESocketShutdownMode { Read , Write , ReadWrite }
enum class	ETimestampTranslation : uint8 { LocalTimestamp , TimeDelta }
enum class	ERecvMultiFlags : uint32 { None = 0x00000000 , RetrieveTimestamps = 0x00000001 }

Functions
	ENUM_CLASS_FLAGS (ERecvMultiFlags)

Enumeration Type Documentation

ERecvMultiFlags

enum class ERecvMultiFlags : uint32

strong

Flags for specifying how an FRecvMulti instance should be initialized

Enumerator
None
RetrieveTimestamps

ESocketConnectionState

enum ESocketConnectionState

Indicates the connection state of the socket

Enumerator
SCS_NotConnected
SCS_Connected
SCS_ConnectionError	Indicates that the end point refused the connection or couldn't be reached

ESocketProtocolFamily

enum class ESocketProtocolFamily : uint8

strong

Indicates the socket protocol of socket being used, typically for BSD Sockets

Enumerator
None	No protocol family specification. Typically defined as AF_UNSPEC
IPv4	IPv4 and IPv6 respectively.
IPv6

ESocketShutdownMode

enum class ESocketShutdownMode

strong

Enumerates socket shutdown modes.

Enumerator
Read	Disables reading on the socket.
Write	Disables writing on the socket.
ReadWrite	Disables reading and writing on the socket.

ESocketType

enum ESocketType

Indicates the type of socket being used (streaming or datagram)

Enumerator
SOCKTYPE_Unknown	Not bound to a protocol yet
SOCKTYPE_Datagram	A UDP type socket
SOCKTYPE_Streaming	A TCP type socket

ETimestampTranslation

enum class ETimestampTranslation : uint8

strong

Specifies how a platform specific timestamp (in this case, a packet timestamp) should be translated

Enumerator
LocalTimestamp	Translates the timestamp into a local timestamp, comparable (with accuracy caveats) to other local timestamps. Use this to get a value comparable to FPlatformTime::Seconds() - if the platform timestamp uses a different clock, this has both a performance (2x internal clock reads i.e. 2x FPlatformTime::Seconds() calls) and accuracy caveat.
TimeDelta	The delta between present platform time vs timestamp - faster than local translation, less accuracy caveats. This is the most accurate measure of time passed since the packet was recorded at an OS/NIC/Thread level, to TranslatePacketTimestamp being called for the packets timestamp - and performs faster (1x FPlatformTime::Seconds() call).

Function Documentation

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

ERecvMultiFlags

)