1. Epic GamesDeveloper
  3. FSteamSocketsSubsystem

FSteamSocketsSubsystem

Steam Sockets specific socket subsystem implementation.

API > API/Plugins > API/Plugins/SteamSockets

Steam Sockets specific socket subsystem implementation. This class can only be used with the SteamSocketsNetDriver and the SteamSocketsNetConnection classes. This subsystem does not support mixing any other NetDriver/NetConnection format. Doing so will cause this protocol to not function.

   
Name FSteamSocketsSubsystem
Type class
Header File /Engine/Plugins/Runtime/Steam/SteamSockets/Source/SteamSockets/Public/SteamSocketsSubsystem.h
Include Path #include "SteamSocketsSubsystem.h"

Syntax

class FSteamSocketsSubsystem :  
    public ISocketSubsystem,  
    public FTSTickerObjectBase,  
    public FSelfRegisteringExec

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FSteamSocketsSubsystem()

   SteamSocketsSubsystem.h  

Structs

Name Remarks
FSteamPendingSocketInformation Structure for handling sockets that cannot be established due to platform login (for listener sockets)
FSteamSocketInformation A struct for holding steam socket information and managing bookkeeping on the protocol.

Typedefs

Name Type Remarks Include Path
SocketHandleInfoMap TMap< SteamSocketHandles, FSteamSocketInformation > Active connection bookkeeping SteamSocketsSubsystem.h

Constants

Name Type Remarks Include Path
SocketSingleton FSteamSocketsSubsystem * Single instantiation of this subsystem SteamSocketsSubsystem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< FInternetAddr > CreateInternetAddr ( const FName RequestedProtocol
)

   SteamSocketsSubsystem.h  

virtual TSharedRef< FInternetAddr > CreateInternetAddr ()

   SteamSocketsSubsystem.h  

virtual FSocket * CreateSocket ( const FName& SocketType,
const FString& SocketDescription,
const FName& ProtocolType
)

   SteamSocketsSubsystem.h  

virtual void DestroySocket ( FSocket* Socket
)

   SteamSocketsSubsystem.h  

virtual TSharedPtr< FInternetAddr > GetAddressFromString ( const FString& IPAddress
)

   SteamSocketsSubsystem.h  

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

   SteamSocketsSubsystem.h  

virtual bool GetHostName ( FString& HostName
)

   SteamSocketsSubsystem.h  

virtual ESocketErrors GetLastErrorCode()

   SteamSocketsSubsystem.h  

virtual bool GetLocalAdapterAddresses ( TArray< TSharedPtr< FInternetAddr > >& OutAddresses
)

   SteamSocketsSubsystem.h  

virtual TArray< TSharedRef< FInternetAddr > > GetLocalBindAddresses()

   SteamSocketsSubsystem.h  

virtual const TCHAR * GetSocketAPIName()

   SteamSocketsSubsystem.h  

virtual bool HasNetworkDevice()

   SteamSocketsSubsystem.h  

virtual bool Init ( FString& Error
)

   SteamSocketsSubsystem.h  

virtual bool IsSocketWaitSupported()

   SteamSocketsSubsystem.h  

bool IsSteamInitialized()

 Basic function to determine if Steam has been initialized properly. SteamSocketsSubsystem.h  

bool IsUsingRelayNetwork()

 Returns if the application is using the SteamSocket relays SteamSocketsSubsystem.h  

virtual bool RequiresChatDataBeSeparate()

   SteamSocketsSubsystem.h  

virtual bool RequiresEncryptedPackets()

   SteamSocketsSubsystem.h  

virtual void Shutdown()

   SteamSocketsSubsystem.h  

virtual bool Tick ( float DeltaTime
)

   SteamSocketsSubsystem.h  

virtual ESocketErrors TranslateErrorCode ( int32 Code
)

   SteamSocketsSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddDelayedListener ( FSteamSocket* ListenSocket,
USteamSocketsNetDriver* NewNetDriver
)

 Delayed listen socket helpers. SteamSocketsSubsystem.h  

void AddSocket ( const FInternetAddr& ForAddr,
FSteamSocket* NewSocket,
FSteamSocket* ParentSocket
)

 Steam socket bookkeeping modifiers. SteamSocketsSubsystem.h  

void CleanSocketInformation ( bool bForceClean
)

   SteamSocketsSubsystem.h  

void DumpSocketInformationMap()

   SteamSocketsSubsystem.h  

virtual bool Exec_Dev ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

   SteamSocketsSubsystem.h  

TSharedPtr< FInternetAddr > GetIdentityAddress()

 Returns this machine's identity in the form of a FInternetAddrSteamSockets. SteamSocketsSubsystem.h  

FSteamSocketInformation * GetSocketInfo ( const FInternetAddr& ForAddress
)

   SteamSocketsSubsystem.h  

FSteamSocketInformation * GetSocketInfo ( SteamSocketHandles InternalSocketHandle
)

 Steam socket queriers. SteamSocketsSubsystem.h  

bool IsLoggedInToSteam()

 Returns if our account is currently logged into the Steam network. SteamSocketsSubsystem.h  

void LinkNetDriver ( FSocket* Socket,
USteamSocketsNetDriver* NewNetDriver
)

   SteamSocketsSubsystem.h  

void OnServerLoginComplete ( bool bWasSuccessful
)

   SteamSocketsSubsystem.h  

void QueueRemoval ( SteamSocketHandles SocketHandle
)

   SteamSocketsSubsystem.h  

void RemoveSocketsForListener ( FSteamSocket* ListenerSocket
)

   SteamSocketsSubsystem.h  

void SteamSocketEventHandler ( SteamNetConnectionStatusChangedCallback_t* ConnectionEvent
)

 SteamAPI internals handler. SteamSocketsSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static FSteamSocketsSubsystem * Create()

 Singleton helpers. SteamSocketsSubsystem.h  

static void Destroy()

   SteamSocketsSubsystem.h  

static ISteamNetworkingSockets * GetSteamSocketsInterface()

   SteamSocketsSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page