Navigation
API > API/Runtime > API/Runtime/Sockets
Socket subsystem module class Wraps the loading of an socket subsystem by name and allows new services to register themselves for use
| Name | FSocketSubsystemModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h |
| Include Path | #include "SocketSubsystemModule.h" |
Syntax
class FSocketSubsystemModule : public IModuleInterface
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSocketSubsystemModule() |
SocketSubsystemModule.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSocketSubsystemModule() |
SocketSubsystemModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DefaultSocketSubsystem | FName | Name of the default socket subsystem defined by the platform | SocketSubsystemModule.h | |
| SocketSubsystems | TMap< FName, class ISocketSubsystem * > | Mapping of all currently loaded subsystems to their name | SocketSubsystemModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ISocketSubsystem * GetSocketSubsystem
(
const FName InSubsystemName |
Main entry point for accessing a socket subsystem by name Will load the appropriate module if the subsystem isn't currently loaded It's possible that the subsystem doesn't exist and therefore can return NULL | SocketSubsystemModule.h | |
virtual void RegisterSocketSubsystem
(
const FName FactoryName, |
Register a new socket subsystem interface with the base level factory provider | SocketSubsystemModule.h | |
virtual void ShutdownModule () |
Called before the module is unloaded, right before the module object is destroyed. | SocketSubsystemModule.h | |
virtual void StartupModule() |
Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load | SocketSubsystemModule.h | |
virtual bool SupportsAutomaticShutdown() |
Override this to set whether your module would like cleanup on application shutdown | SocketSubsystemModule.h | |
virtual bool SupportsDynamicReloading() |
Override this to set whether your module is allowed to be unloaded on the fly | SocketSubsystemModule.h | |
virtual void UnregisterSocketSubsystem
(
const FName FactoryName |
Unregister an existing online subsystem interface from the base level factory provider | SocketSubsystemModule.h |