1. Epic GamesDeveloper
  3. FSteamSocketsSubsystem

FSteamSocketsSubsystem

Steam Sockets specific socket subsystem implementation.

Unreal Engine C++ API Reference > Plugins > SteamSockets

Inheritance Hierarchy

References

   
Module SteamSockets
Header /Engine/Plugins/Runtime/Steam/SteamSockets/Source/SteamSockets/Public/SteamSocketsSubsystem.h
Include #include "SteamSocketsSubsystem.h"

Syntax

class FSteamSocketsSubsystem :  
    public ISocketSubsystem,  
    public FTSTickerObjectBase,  
    public FSelfRegisteringExec

Remarks

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.

Variables

  Type Name Description
Protected variable bool bShouldTestPeek Flag for testing peek messaging (only usable in non-shipping builds)
Protected variable bool bUseRelays Determines if the connections are going to be using the relay network
Protected variable int32 LastSocketError Last error set by the socket subsystem or one of its sockets
Protected variable TArray< FSteamPendingSocketInformation > PendingListenerArray Array of listeners we need to activate.
Protected variable SocketHandleInfoMap SocketInformationMap  
Protected variable TSharedPtr< class FSteamClientInstanceHandler > SteamAPIClientHandle Steam Client API Handle
Protected variable TSharedPtr< class FSteamServerInstanceHandler > SteamAPIServerHandle Steam Server API Handle
Protected variable TUniquePtr< class FSteamSocketsTaskManagerInterface > SteamEventManager Event manager for Steam tasks
Protected variable FDelegateHandle SteamServerLoginDelegateHandle Delegate handle for handling when a dedicated server logs into the Steam platform.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

AddDelayedListener ( FSteamSocket* ListenSocket,
USteamSocketsNetDriver* NewNetDriver
)

 Delayed listen socket helpers.
Protected function void

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

 Steam socket bookkeeping modifiers.
Protected function void

CleanSocketInformation ( bool bForceClean
)

  
Protected function Static FSteamSocketsSubsystem *

Create ()

 Singleton helpers.
Protected function Static void

Destroy ()

  
Protected function Const void  
Protected function TSharedPtr< FInternetAddr > Returns this machine's identity in the form of a FInternetAddrSteamSockets.
Protected function FSteamSocketInformation *

GetSocketInfo ( const FInternetAddr& ForAddress
)

 Steam socket queriers.
Protected function FSteamSocketInformation *

GetSocketInfo ( SteamSocketHandles InternalSocketHandle
)

 Steam socket queriers.
Public function Static ISteamNetworkingSockets *  
Protected function Const bool Returns if our account is currently logged into the Steam network.
Public function Const bool Basic function to determine if Steam has been initialized properly.
Public function Const bool Returns if the application is using the SteamSocket relays
Protected function void

LinkNetDriver ( FSocket* Socket,
USteamSocketsNetDriver* NewNetDriver
)

  
Protected function void

OnServerLoginComplete ( bool bWasSuccessful
)

  
Protected function void

QueueRemoval ( SteamSocketHandles SocketHandle
)

  
Protected function void

RemoveSocketsForListener ( FSteamSocket* ListenerSocket
)

  
Protected function void

SteamSocketEventHandler ( SteamNetConnectionStatusChangedCallback_t* ConnectionEvent
)

 SteamAPI internals handler.

Overridden from ISocketSubsystem

  Type Name Description
Public function Virtual TSharedRef< FInternetAddr >

CreateInternetAddr ( const FName ProtocolType
)

 Create a FInternetAddr of the desired protocol
Public function Virtual TSharedRef< FInternetAddr > Create a proper FInternetAddr representation
Public function Virtual FSocket *

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

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

DestroySocket ( FSocket* Socket
)

 Cleans up a socket class
Public function Virtual TSharedPtr< FInternetAddr >

GetAddressFromString ( const FString& InAddress
)

 Serializes a string that only contains an address.
Public function Virtual 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 bool

GetHostName ( FString& HostName
)

 Determines the name of the local machine
Public function Virtual 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 TArray< TSharedRef< FInternetAddr > > Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag.
Public function Virtual Const const TCHAR * Get the name of the socket subsystem
Public function Virtual bool  
Public function Virtual bool

Init ( FString& Error
)

 Does per platform initialization of the sockets library
Public function Virtual Const bool Returns true if FSocket::Wait is supported by this socket subsystem.
Public function Virtual bool Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way.
Public function Virtual bool Some platforms require packets be encrypted.
Public function Virtual void Performs platform specific socket clean up
Public function Virtual ESocketErrors

TranslateErrorCode ( int32 Code
)

 Translates the platform error code to a ESocketErrors enum

Overridden from FTSTickerObjectBase

  Type Name Description
Public function Virtual bool

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Overridden from FExec

  Type Name Description
Protected function Virtual bool

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

 Implementation of Exec that is only called in non-shipping targets

Classes

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

Typedefs

Name Description
SocketHandleInfoMap Active connection bookkeeping

Constants

Name Description
SocketSingleton Single instantiation of this subsystem

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page