| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/OnlineBeaconHost.h |
Include |
#include "OnlineBeaconHost.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, NotPlaceable, Config=Engine)
class AOnlineBeaconHost : public AOnlineBeacon
Main actor that listens for side channel communication from another Unreal Engine application
The AOnlineBeaconHost listens for connections to route to a registered AOnlineBeaconHostObject The AOnlineBeaconHostObject is responsible for spawning the server version of the AOnlineBeaconClient The AOnlineBeaconHost pairs the two client actors, verifies the validity of the exchange, and accepts/continues the connection
Name | Description | ||
---|---|---|---|
|
ListenPort |
Configured listen port for this beacon host |
Name | Description | |
---|---|---|
|
AOnlineBeaconHost ( |
Name | Description | ||
---|---|---|---|
|
DisconnectClient ( |
Disconnect a given client from the host |
|
|
AOnlineBeaco... |
GetClientActor ( |
Get a client beacon actor for a given connection |
|
AOnlineBeaco... |
GetHost ( |
Get the host responsible for a given beacon type |
|
GetListenPort() |
Get the listen port for this beacon |
|
|
InitHost() |
Initialize the host beacon on a specified port Creates the net driver and begins listening for connections |
|
|
RegisterHost ( |
Register a beacon host and its client actor factory |
|
|
RemoveClientActor ( |
Remove a client beacon actor from the list of active connections |
|
|
UnregisterHost ( |
Unregister a beacon host, making future connections of a given type unresponsive |
Name | Description | ||
---|---|---|---|
|
HandleNetworkFailure ( |
Notification of network error messages, allows a beacon to handle the failure |
Name | Description | ||
---|---|---|---|
|
OnNetCleanup ( |
Handles cleaning up the associated Actor when killing the connection |
Name | Description | ||
---|---|---|---|
|
NotifyControlMessage ( |
Handler for messages sent through a remote connection's control channel not required to handle the message, but if it reads any data from Bunch, it MUST read the ENTIRE data stream for that message (i.e. use FNetControlMessage |
Name |
Description |
---|---|
FOnBeaconConnected |
Delegate to route a connection event to the appropriate beacon host, by type |
FOnBeaconSpawned |
Delegate to route a connection attempt to the appropriate beacon host, by type |