Navigation
| Name | Sockets |
| Type | Runtime |
| Location | /Engine/Source/Runtime/Sockets/ |
| Module Build Rules | Sockets.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FInternetAddr | Represents an internet address. All data is in network byte order |
| FMultichannelTcpReceiver | Implements a receiver for multichannel TCP sockets. |
| FMultichannelTcpSender | Implements a sender for multichannel TCP sockets. |
| FMultichannelTcpSocket | Class to multiplex several streams on a single TCP socket. |
| FNetworkFileArchive | A helper class for wrapping some of the network file payload specifics |
| FResolveInfo | Abstract interface used by clients to get async host name resolution to work in a cross-platform way |
| FResolveInfoAsync | Class for creating a background thread to resolve a host. |
| FResolveInfoCached | A non-async resolve info for returning cached results |
| FSimpleAbstractSocket | Simple abstraction for sockets that allows FNFSMessageHeader to use either an ordinary socket or a mutichannel socket |
| FSimpleAbstractSocket_FMultichannelTCPSocket | Multichannel socket version of FSimpleAbstractSocket |
| FSimpleAbstractSocket_FSocket | Ordinary socket version of FSimpleAbstractSocket |
| FSocket | This is our abstract base class that hides the platform specific socket implementation |
| FSocketDeleter | Deleter object that can be used with unique & shared pointers that store FSockets. |
| FSocketSubsystemModule | Socket subsystem module class Wraps the loading of an socket subsystem by name and allows new services to register themselves for use |
Structs
| Name | Remarks |
|---|---|
| FAddressInfoResult | |
| FAddressInfoResultData | |
| FFileInfo | A helper class for storing all available file info. |
| FInternetAddrConstKeyMapFuncs | |
| FInternetAddrKeyMapFuncs | KeyFuncs for mapping/hashing FInternetAddr shared references |
| FNFSMessageHeader | Simple wrapper for sending and receiving atomic packets |
| FRecvMulti | Stores the persistent state and packet buffers/data, for receiving packets with FSocket::RecvMulti. |
| FServerTOC | Helper struct to hold and quickly access server TOC. |
Interfaces
| Name | Remarks |
|---|---|
| ISocketSubsystem | This is the base interface to abstract platform specific sockets API differences. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAsyncGetAddressInfoCallback | TFunction< void(FAddressInfoResult)> | AddressInfoTypes.h | |
| FOnMultichannelTcpOkToSend | TBaseDelegate_TwoParams< bool, int32, uint32 > | Declares a delegate to be invoked when checking if bandwidth permits sending a packet | MultichannelTcpSender.h |
| FOnMultichannelTcpReceive | TBaseDelegate_ThreeParams< void, const TArray< uint8 > &, uint32, bool > | Declares a delegate to be invoked when data has been received. | MultichannelTcpReceiver.h |
| FSocketSubsystemModulePtr | TSharedPtr< FSocketSubsystemModule > | Public references to the socket subsystem module pointer should use this | SocketSubsystemModule.h |
| FUniqueSocket | TUniquePtr< FSocket, FSocketDeleter > | SocketSubsystem.h | |
| IOnlineSocketPtr | TSharedPtr< ISocketSubsystem > | SocketSubsystem.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAddressInfoFlags | |
| EConnectionFlags | |
| ERecvMultiFlags | Flags for specifying how an FRecvMulti instance should be initialized |
| ESocketConnectionState | Indicates the connection state of the socket |
| ESocketProtocolFamily | Indicates the socket protocol of socket being used, typically for BSD Sockets |
| ESocketReceiveFlags::Type | Enumerates socket receive flags. |
| ESocketShutdownMode | Enumerates socket shutdown modes. |
| ESocketType | Indicates the type of socket being used (streaming or datagram) |
| ESocketWaitConditions::Type | Enumerates socket wait conditions. |
| ETimestampTranslation | Specifies how a platform specific timestamp (in this case, a packet timestamp) should be translated |
| NFS_Channels::Type | Reserved channels for the network file system over multichannel tcp. |
| NFS_Messages::Type | Message commands, these correspond to the operations of the low level file system. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IPv4 | const FLazyName | SocketTypes.h | ||
| IPv6 | const FLazyName | SocketTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| AddressInfoTypes.h | |||
| NetworkMessage.h | |||
| SocketTypes.h |