1. Epic GamesDeveloper
  3. APartyBeaconClient

APartyBeaconClient

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

Unreal Engine C++ API Reference > Plugins > OnlineSubsystemUtils

Inheritance Hierarchy

References

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

Syntax

UCLASS (Transient, NotPlaceable, Config=Engine)  
class APartyBeaconClient : 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 FPartyReservation 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 EClientRequestType 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 FOnReservationRequestComplete ReservationRequestComplete Delegate for reservation request responses

Constructors

  Type Name Description
Public function  

APartyBeaconClient ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
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 FPartyReservation &  
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 FOnReservationRequestComplete & Delegate triggered when a response from the party 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

RequestAddOrUpdateReservation ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

 Sends a request to the remote host.
Public function Virtual bool

RequestReservation ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

 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& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

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

RequestReservationUpdate ( const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session.
Public function Virtual bool

RequestReservationUpdate ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session.
Public function Virtual bool

RequestReservationUpdate ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session.
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerAddOrUpdateReservationRequest ( const FString& SessionId,
const FPartyReservation& Reservation
)

 Tell the server about the reservation add or update request being made
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerCancelReservationRequest ( const FUniqueNetIdRepl& PartyLeader
)

 Tell the server to cancel a pending or existing reservation
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerRemoveMemberFromReservationRequest ( const FString& SessionId,
const FPartyReservation& ReservationUpdate
)

 Tell the server that we are removing members from our reservation
Protected function Virtual UFunction Server, Reliable withvalidation void

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

 Tell the server about the reservation request being made
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerUpdateReservationRequest ( const FString& SessionId,
const FPartyReservation& ReservationUpdate
)

 Tell the server about the reservation update 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.