Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > SteamSockets > FSteamSocketsSubsystem

Light Theme

Dark Theme

FSteamSocketsSubsystem

Steam Sockets specific socket subsystem implementation.

Windows

MacOS

Linux

Inheritance Hierarchy

ISocketSubsystem

FTickerObjectBase

FSelfRegisteringExec

FSteamSocketsSubsystem

References

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

Syntax

class FSteamSocketsSubsystem :
    public ISocketSubsystem,
    public FTickerObjectBase,
    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

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

Constructors

	Name	Description
	FSteamSocketsSubsystem()

Functions

	Name	Description
void	AddDelayedListener ( FSteamSocket* ListenSocket, USteamSocketsNetDriver* NewNet... )	Delayed listen socket helpers.
void	AddSocket ( const FInternetAddr& ForAddr, FSteamSocket* NewSocket, FSteamSocket* ParentSocket )	Steam socket bookkeeping modifiers.
void	CleanSocketInformation ( bool bForceClean )
FSteamSocket...	Create()	Singleton helpers.
void	Destroy()
void	DumpSocketInformationMap()
TSharedPtr< ...	GetIdentityAddress()	Returns this machine's identity in the form of a FInternetAddrSteamSockets.
FSteamSocket...	GetSocketInfo ( const FInternetAddr& ForAddress )	Steam socket queriers.
FSteamSocket...	GetSocketInfo ( SteamSocketHandles InternalSocketHa... )	Steam socket queriers.
ISteamNetwor...	GetSteamSocketsInterface()
bool	IsLoggedInToSteam()	Returns if our account is currently logged into the Steam network.
bool	IsSteamInitialized()	Basic function to determine if Steam has been initialized properly.
bool	IsUsingRelayNetwork()	Returns if the application is using the SteamSocket relays
void	LinkNetDriver ( FSocket* Socket, USteamSocketsNetDriver* NewNet... )
void	OnServerLoginComplete ( bool bWasSuccessful )
void	QueueRemoval ( SteamSocketHandles SocketHandle )
void	RemoveSocketsForListener ( FSteamSocket* ListenerSocket )
void	SteamSocketEventHandler ( SteamNetConnectionStatusChangedCall... )	SteamAPI internals handler.

Overridden from ISocketSubsystem

	Name	Description
TSharedRef< ...	CreateInternetAddr ( const FName ProtocolType )	Create a FInternetAddr of the desired protocol
TSharedRef< ...	CreateInternetAddr()	Create a proper FInternetAddr representation
FSocket *...	CreateSocket ( const FName& SocketType, const FString& SocketDescription, const FName& ProtocolName )	Creates a socket using the given protocol name.
void	DestroySocket ( FSocket* Socket )	Cleans up a socket class
TSharedPtr< ...	GetAddressFromString ( const FString& InAddress )	Serializes a string that only contains an address.
FAddressInfo...	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.
bool	GetHostName ( FString& HostName )	Determines the name of the local machine
ESocketError...	GetLastErrorCode()	Returns the last error that has happened
bool	GetLocalAdapterAddresses ( TArray< TSharedPtr< FInternetAddr >... )	Gets the list of addresses associated with the adapters on the local computer.
TArray< TSha...	GetLocalBindAddresses()	Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag.
const TCHAR ...	GetSocketAPIName()	Get the name of the socket subsystem
bool	HasNetworkDevice()
bool	Init ( FString& Error )	Does per platform initialization of the sockets library
bool	IsSocketWaitSupported()	Returns true if FSocket::Wait is supported by this socket subsystem.
bool	RequiresChatDataBeSeparate()	Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way.
bool	RequiresEncryptedPackets()	Some platforms require packets be encrypted.
void	Shutdown()	Performs platform specific socket clean up
ESocketError...	TranslateErrorCode ( int32 Code )	Translates the platform error code to a ESocketErrors enum

Overridden from FTickerObjectBase

		Name	Description
	bool	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Classes

	Name	Description
	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	Description
SocketHandleInfoMap	Active connection bookkeeping

Constants

Name	Description
SocketSingleton	Single instantiation of this subsystem

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss