1. Epic GamesDeveloper
  3. ISocketSubsystem

ISocketSubsystem

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

API > API/Runtime > API/Runtime/Sockets

Inheritance Hierarchy

References

   
Module Sockets
Header /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h
Include #include "SocketSubsystem.h"

Syntax

class ISocketSubsystem

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddHostNameToCache ( const ANSICHAR* HostName,
TSharedPtr< class FInternetAddr > Addr
)

 Stores the ip address with the matching host name
Public function int32

BindNextPort ( FSocket* Socket,
FInternetAddr& Addr,
int32 PortCount,
int32 PortIncrement
)

 Bind to next available port.
Public function Virtual TSharedRef< FInternetAddr >

CreateInternetAddr ( const FName ProtocolType
)

 Create a FInternetAddr of the desired protocol
Public function TSharedRef< FInternetAddr > Create a proper FInternetAddr representation
Public function Virtual TUniquePtr< FRecvMulti >

CreateRecvMulti ( int32 MaxNumPackets,
int32 MaxPacketSize,
ERecvMultiFlags Flags
)

 Create a platform specific FRecvMulti representation
Public function Virtual Const FResolveInfoCached * Creates a resolve info cached struct to hold the resolved address
Public function FSocket *

CreateSocket ( const FName& SocketType,
const FString& SocketDescription,
const FName& ProtocolName
)

 Creates a socket using the given protocol name.
Public function Virtual FSocket *

CreateSocket ( const FName& SocketType,
const FString& SocketDescription,
bool bForceUDP
)

 Creates a socketSocketType type of socket to create (DGram, Stream, etc)
Public function FUniqueSocket

CreateUniqueSocket ( const FName& SocketType,
const FString& SocketDescription,
const FName& ProtocolName
)

 Creates a socket using the given protocol name, wrapped in a unique pointer that will call DestroySocket automatically - do not call it explicitly! This SocketSubsystem must also outlive the sockets it creates.
Public function FUniqueSocket

CreateUniqueSocket ( const FName& SocketType,
const FString& SocketDescription,
bool bForceUDP
)

 Creates a socket wrapped in a unique pointer that will call DestroySocket automatically - do not call it explicitly! This SocketSubsystem must also outlive the sockets it creates.
Public function void

DestroySocket ( FSocket* Socket
)

 Cleans up a socket class
Public function Static ISocketSubsystem *

Get ( const FName& SubsystemName
)

 Get the singleton socket subsystem for the given named subsystem
Public function TSharedPtr< FInternetAddr >

GetAddressFromString ( const FString& InAddress
)

 Serializes a string that only contains an address.
Public function FAddressInfoResult

GetAddressInfo ( const TCHAR* HostName,
const TCHAR* ServiceName,
EAddressInfoFlags QueryFlags,
const FName ProtocolTypeName,
ESocketType SocketType
)

 Gets the address information of the given hostname and outputs it into an array of resolvable addresses.
Public function Virtual void

GetAddressInfoAsync ( FAsyncGetAddressInfoCallback Callback,
const TCHAR* HostName,
const TCHAR* ServiceName,
EAddressInfoFlags QueryFlags,
const FName ProtocolTypeName,
ESocketType SocketType
)

 Async variant of GetAddressInfo that fetches the data from the above function in an asynchronous task executed on an available background thread.
Public function Virtual FResolveInfo *

GetHostByName ( const ANSICHAR* HostName
)

 Creates a platform specific async hostname resolution object
Public function bool

GetHostByNameFromCache ( const ANSICHAR* HostName,
TSharedPtr< class FInternetAddr >& Addr
)

 Checks the host name cache for an existing entry (faster than resolving again)
Public function bool

GetHostName ( FString& HostName
)

 Determines the name of the local machine
Public function ESocketErrors Returns the last error that has happened
Public function Virtual bool Gets the list of addresses associated with the adapters on the local computer.
Public function Virtual TSharedRef< FInternetAddr > Get a local IP to bind to.
Public function Virtual TArray< TSharedRef< FInternetAddr > > Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag.
Public function Virtual TSharedRef< FInternetAddr >

GetLocalHostAddr ( FOutputDevice& Out,
bool& bCanBindAll
)

 Uses the platform specific look up to determine the host address
Public function Virtual bool Returns the multihome address if the flag is present and valid.
Protected function Virtual Const ESocketProtocolFamily

GetProtocolFamilyFromName ( const FName& InProtocolName
)

 Conversion functions from the SocketProtocolFamily enum to the new FName system.
Protected function Virtual Const FName

GetProtocolNameFromFamily ( ESocketProtocolFamily InProtocolFamily
)

  
Public function Const const TCHAR * Get the name of the socket subsystem
Public function const TCHAR *

GetSocketError ( ESocketErrors Code
)

 Returns a human readable string from an error code
Public function bool  
Public function bool

Init ( FString& Error
)

 Does per platform initialization of the sockets library
Public function Virtual Const bool Returns true if FSocket::RecvFromWithPktInfo is supported by this socket subsystem.
Public function Virtual Const bool Returns true if FSocket::RecvMulti is supported by this socket subsystem
Public function Const bool Returns true if FSocket::Wait is supported by this socket subsystem.
Public function void

RemoveHostNameFromCache ( const ANSICHAR* HostName
)

 Removes the host name to ip mapping from the cache
Public function bool Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way.
Public function bool Some platforms require packets be encrypted.
Public function void Performs platform specific socket clean up
Public function Static void Shutdown all registered subsystems
Public function ESocketErrors

TranslateErrorCode ( int32 Code
)

 Translates the platform error code to a ESocketErrors enum
Public function Virtual double

TranslatePacketTimestamp ( const FPacketTimestamp& Timestamp,
ETimestampTranslation Translation
)

 Converts a platform packet timestamp, into a local timestamp, or into a time delta etc.

Deprecated Functions

  Type Name Description
Public function Virtual TSharedRef< FInternetAddr >

CreateInternetAddr ( uint32 Address,
uint32 Port
)

 To support different address sizes, use CreateInternetAddr with no arguments and call SetIp/SetRawIp and SetPort on the returned object
Public function Virtual FSocket *

CreateSocket ( const FName& SocketType,
const FString& SocketDescription,
ESocketProtocolFamily ProtocolType
)

 Use the CreateSocket with the FName parameter for support for multiple protocol types.
Public function Virtual FAddressInfoResult

GetAddressInfo ( const TCHAR* HostName,
const TCHAR* ServiceName,
EAddressInfoFlags QueryFlags,
ESocketProtocolFamily ProtocolType,
ESocketType SocketType
)

 Migrate to GetAddressInfo that takes an FName as the protocol specification.
Public function Virtual ESocketErrors

GetHostByName ( const ANSICHAR* HostName,
FInternetAddr& OutAddr
)

 Please use GetAddressInfo to query hostnames

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page