APartyBeaconClient

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

Choose your operating system:

Windows

macOS

Linux

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

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

FPartyReservati...

 

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

EClientRequestT...

 

RequestType

Type of request currently being handled by this client beacon

Protected variable

FOnReservationC...

 

ReservationCountUpdate

Delegate for reservation count updates

Protected variable

FOnReservationF...

 

ReservationFull

Delegate for reservation full

Protected variable

FOnReservationR...

 

ReservationRequestComplete

Delegate for reservation request responses

Constructors

Name Description

Public function

APartyBeaconClient

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

CancelReservation()

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

 

ClientCancelReservationResponse

(
    EPartyReservationResult::Type Reser...
)

Response from the host session after making a cancellation request

Public function Virtual UFunction Client, Reliable

void

 

ClientReservationResponse

(
    EPartyReservationResult::Type Reser...
)

Response from the host session after making a reservation request

Public function Virtual UFunction Client, Reliable

void

 

ClientSendReservationFull()

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 FParty...

 

GetPendingReservation()

Protected function

void

 

OnCancelledComplete()

Delegate triggered when a cancel reservation request is complete

Protected function

void

 

OnCancelledFailsafe()

Delegate triggered if the client doesn't hear from the server in time

Public function

FOnReservati...

 

OnReservationCountUpdate()

Delegate triggered when the host indicated a reservation count has changed

Public function

FOnReservati...

 

OnReservationFull()

Delegate triggered when the host indicated the reservation is full

Public function

FOnReservati...

 

OnReservationRequestComplete()

Delegate triggered when a response from the party beacon host has been received

Protected function

void

 

ProcessCancelReservationResponse

(
    EPartyReservationResult::Type Reser...
)

Process a response to our CancelReservation request to the server

Protected function

void

 

ProcessReservationFull()

Process a response from the server that the reservation beacon is full

Protected function

void

 

ProcessReservationResponse

(
    EPartyReservationResult::Type Reser...
)

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& Requesting...,
    const TArray< FPlayerReservation > ...
)

Sends a request to the remote host.

Public function Virtual

bool

 

RequestReservation

(
    const FOnlineSessionSearchResult& ...,
    const FUniqueNetIdRepl& Requesting...,
    const TArray< FPlayerReservation > ...
)

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& Requesting...,
    const TArray< FPlayerReservation > ...
)

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& Requesting...,
    const TArray< FPlayerReservation > ...,
    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& ...,
    const FUniqueNetIdRepl& Requesting...,
    const TArray< FPlayerReservation > ...,
    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& Requesting...,
    const TArray< FPlayerReservation > ...,
    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& Reservati...
)

Tell the server about the reservation add or update request being made

Protected function Virtual UFunction Server, Reliable withvalidation

void

 

ServerCancelReservationRequest

(
    const FUniqueNetIdRepl& PartyLeade...
)

Tell the server to cancel a pending or existing reservation

Protected function Virtual UFunction Server, Reliable withvalidation

void

 

ServerRemoveMemberFromReservationRequest

(
    const FString& SessionId,
    const FPartyReservation& Reservati...
)

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& Reservati...
)

Tell the server about the reservation request being made

Protected function Virtual UFunction Server, Reliable withvalidation

void

 

ServerUpdateReservationRequest

(
    const FString& SessionId,
    const FPartyReservation& Reservati...
)

Tell the server about the reservation update request being made

Overridden from AOnlineBeaconClient

Name Description

Public function Virtual

void

 

OnConnected()

A connection has been made and RPC/replication can begin

Overridden from AOnlineBeacon

Name Description

Public function Virtual

void

 

OnFailure()

Notification that failure needs to be handled

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.