1. Epic GamesDeveloper
  3. AOnlineBeaconHost

AOnlineBeaconHost

Main actor that listens for side channel communication from another Unreal Engine application

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

   
Module OnlineSubsystemUtils
Header /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/OnlineBeaconHost.h
Include #include "OnlineBeaconHost.h"

Syntax

UCLASS&40;Transient, NotPlaceable, Config&61;Engine&41;  
class AOnlineBeaconHost : public AOnlineBeacon

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Config bool bAuthRequired Set this to true if you require clients to negotiate auth prior to joining the beacon
Public variable UProperty Config bool bReuseAddressAndPort Whether to configure the listening socket to allow reuse of the address and port.
Public variable UProperty Config int32 ListenPort Configured listen port for this beacon host
Protected variable UProperty Config uint32 MaxAuthTokenSize  

Constructors

  Type Name Description
Public function  

AOnlineBeaconHost ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Disconnect a given client from the host
Public function Virtual AOnlineBeaconClient *

GetClientActor ( UNetConnection* Connection
)

 Get a client beacon actor for a given connection
Protected function FString

GetDebugName ( UNetConnection* Connection
)

  
Public function AOnlineBeaconHostObject *

GetHost ( const FString& BeaconType
)

 Get the host responsible for a given beacon type
Public function Virtual int32 Get the listen port for this beacon
Public function Virtual bool Initialize the host beacon on a specified port Creates the net driver and begins listening for connections
Public function Virtual void Register a beacon host and its client actor factory
Public function Virtual void Remove a client beacon actor from the list of active connections
Protected function Virtual bool

StartVerifyAuthentication ( const FUniqueNetId& PlayerId,
const FString& LoginOptions,
const FString& AuthenticationToken,
const FOnAuthenticationVerificationCompleteDelegate& OnComplete
)

 Start verifying an authentication token for a connection.
Public function Virtual void

UnregisterHost ( const FString& BeaconType
)

 Unregister a beacon host, making future connections of a given type unresponsive
Protected function Virtual bool

VerifyJoinForBeaconType ( const FUniqueNetId& PlayerId,
const FString& BeaconType
)

 Verify user authentication once the beacon type is known.

Overridden from AOnlineBeacon

  Type Name Description
Public function Virtual void

HandleNetworkFailure ( UWorld* World,
UNetDriver* NetDriver,
ENetworkFailure::Type FailureType,
const FString& ErrorString
)

 Notification of network error messages, allows a beacon to handle the failure

Overridden from AActor

  Type Name Description
Public function Virtual void

OnNetCleanup ( UNetConnection* Connection
)

 Handles cleaning up the associated Actor when killing the connection

Overridden from FNetworkNotify

  Type Name Description
Public function Virtual void

NotifyControlMessage ( UNetConnection* Connection,
uint8 MessageType,
FInBunch& Bunch
)

 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::Receive())

Typedefs

Name Description
FNetCloseResult  
FOnAuthenticationVerificationCompleteDelegate Delegate executed when user authentication has completed.
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

Deprecated Functions

  Type Name Description
Protected function void This version of the OnAuthenticationVerificationComplete is deprecated. Please use the new OnAuthenticationVerificationComplete method instead.
Protected function Virtual bool

StartVerifyAuthentication ( const FUniqueNetId& PlayerId,
const FString& AuthenticationToken
)

 This version of the StartVerifyAuthentication is deprecated. Please use the new StartVerifyAuthentication method instead.
Protected function Virtual bool

StartVerifyAuthentication ( const FUniqueNetId& PlayerId,
const FString& AuthenticationToken,
const FOnAuthenticationVerificationCompleteDelegate& OnComplete
)

 This version of the StartVerifyAuthentication is deprecated. Please use the new StartVerifyAuthentication method instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page