Sockets

Classes

Name

Description

Public struct

FFileInfo

A helper class for storing all available file info.

Public class

FInternetAddr

Represents an internet address. All data is in network byte order

Public class

FMultichannelTcpReceiver

Implements a receiver for multichannel TCP sockets.

Public class

FMultichannelTcpSender

Implements a sender for multichannel TCP sockets.

Public class

FMultichannelTcpSocket

Class to multiplex several streams on a single TCP socket.

Public class

FNetworkFileArchive

A helper class for wrapping some of the network file payload specifics

Public struct

FNFSMessageHeader

Simple wrapper for sending and receiving atomic packets

Public class

FResolveInfo

Abstract interface used by clients to get async host name resolution to work in a cross-platform way

Public class

FResolveInfoAsync

Class for creating a background thread to resolve a host.

Public class

FResolveInfoCached

A non-async resolve info for returning cached results

Public struct

FServerTOC

Helper struct to hold and quickly access server TOC.

Public class

FSimpleAbstractSocket

Simple abstraction for sockets that allows FNFSMessageHeader to use either an ordinary socket or a mutichannel socket

Public class

FSimpleAbstractSocket_FMultichannelTCPSocket

Multichannel socket version of FSimpleAbstractSocket

Public class

FSimpleAbstractSocket_FSocket

Ordinary socket version of FSimpleAbstractSocket

Public class

FSocket

This is our abstract base class that hides the platform specific socket implementation

Public class

FSocketSubsystemModule

Socket subsystem module class Wraps the loading of an socket subsystem by name and allows new services to register themselves for use

Public class

ISocketSubsystem

This is the base interface to abstract platform specific sockets API differences.

Constants

Name

Description

DEFAULT_HTTP_FILE_SERVING_PORT

Default port to use when making file server tcp connections (used if no protocol is specified)

DEFAULT_TCP_FILE_SERVING_PORT

MultichannelMagic

Magic number used to verify packet header

Typedefs

Name

Description

FOnMultichannelTcpOkToSend

Declares a delegate to be invoked when checking if bandwidth permits sending a packet

FOnMultichannelTcpReceive

Declares a delegate to be invoked when data has been received.

FSocketSubsystemModulePtr

Public references to the socket subsystem module pointer should use this

IOnlineSocketPtr

Enums

Name

Description

Public enum

ESocketConnectionState

Indicates the connection state of the socket

Public enum

ESocketErrors

All supported error types by the engine, mapped from platform specific values

Public enum

ESocketReceiveFlags::Type

Enumerates socket receive flags.

Public enum

ESocketType

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

Public enum

ESocketWaitConditions::Type

Enumerates socket wait conditions.

Public enum

NFS_Channels::Type

Reserved channels for the network file system over multichannel tcp.

Public enum

NFS_Messages::Type

Message commands, these correspond to the operations of the low level file system.

Variables

Name Description

Public variable

 

SOCKETS_API

Public variable

 

SOCKETS_API