1. Epic GamesDeveloper
  3. ASpectatorBeaconClient

ASpectatorBeaconClient

A beacon client used for making reservations with an existing game session

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Transient, NotPlaceable, Config&61;Engine&41;  
class ASpectatorBeaconClient : public AOnlineBeaconClient

Remarks

A beacon client used for making reservations with an existing game session

Variables

  Type Name Description
Protected variable UProperty bool bCancelReservation Has the reservation request been canceled
Protected variable UProperty bool bPendingReservationSent Has the reservation request been delivered
Protected variable FTimerHandle CancelRPCFailsafe Timer to trigger a cancel reservation request if the server doesn't respond in time
Protected variable UProperty FString DestSessionId Session Id of the destination host
Protected variable FTimerHandle PendingCancelResponseTimerHandle  
Protected variable UProperty FSpectatorReservation PendingReservation Pending reservation that will be sent upon connection with the intended host
Protected variable FTimerHandle PendingReservationFullTimerHandle  
Protected variable FTimerHandle PendingReservationUpdateTimerHandle  
Protected variable FTimerHandle PendingResponseTimerHandle Timers for delaying various responses (debug)
Protected variable UProperty ESpectatorClientRequestType RequestType Type of request currently being handled by this client beacon
Protected variable FOnReservationCountUpdate ReservationCountUpdate Delegate for reservation count updates
Protected variable FOnReservationFull ReservationFull Delegate for reservation full
Protected variable FOnSpectatorReservationRequestComplete ReservationRequestComplete Delegate for reservation request responses

Constructors

  Type Name Description
Public function  

ASpectatorBeaconClient ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Cancel an existing request to the remote host to revoke allocated space on the server.
Protected function void

ClearTimers ( bool bCallFailSafeIfNeeded
)

 Clear out all the timer handles listed above
Public function Virtual UFunction Client, Reliable void Response from the host session after making a cancellation request
Public function Virtual UFunction Client, Reliable void Response from the host session after making a reservation request
Public function Virtual UFunction Client, Reliable void Response from the host session that the reservation is full
Public function Virtual UFunction Client, Reliable void

ClientSendReservationUpdates ( int32 NumRemainingReservations
)

 Response from the host session that the reservation count has changed
Protected function FTimerHandle

DelayResponse ( FTimerDelegate& Delegate,
float Delay
)

 Trigger the given delegate at a later time
Public function Const const FSpectatorReservation &  
Protected function void Delegate triggered when a cancel reservation request is complete
Protected function void Delegate triggered if the client doesn't hear from the server in time
Public function FOnReservationCountUpdate & Delegate triggered when the host indicated a reservation count has changed
Public function FOnReservationFull & Delegate triggered when the host indicated the reservation is full
Public function FOnSpectatorReservationRequestComplete & Delegate triggered when a response from the spectator beacon host has been received
Protected function void Process a response to our CancelReservation request to the server
Protected function void Process a response from the server that the reservation beacon is full
Protected function void Process a response to our RequestReservation request to the server
Protected function void

ProcessReservationUpdate ( int32 NumRemainingReservations
)

 Process a response from the server with an update to the number of consumed reservations
Public function Virtual bool

RequestReservation ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingSpectator,
const FPlayerReservation& Reservation
)

 Sends a request to the remote host to allow the specified members to reserve space in the host's session.
Public function Virtual bool

RequestReservation ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingSpectator,
const FPlayerReservation& Reservation
)

 Sends a request to the remote host to allow the specified members to reserve space in the host's session.
Protected function Virtual UFunction Server, Reliable withvalidation void Tell the server to cancel a pending or existing reservation
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerReservationRequest ( const FString& SessionId,
const FSpectatorReservation& Reservation
)

 Tell the server about the reservation request being made

Overridden from AOnlineBeaconClient

  Type Name Description
Public function Virtual void A connection has been made and RPC/replication can begin

Overridden from AOnlineBeacon

  Type Name Description
Public function Virtual void Notification that failure needs to be handled

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page