IpDrv.PartyBeaconClient

Extends

PartyBeacon

Modifiers

native

This class is used to connect to a network beacon in order to request a reservation for their party with that host

Core.Object
|   
+-- IpDrv.PartyBeacon
   |   
   +-- IpDrv.PartyBeaconClient

Delegates Summary
		OnHostHasCancelled ()
		OnHostIsReady ()
		OnReservationCountUpdated (int ReservationRemaining)
		OnReservationRequestComplete (EPartyReservationResult ReservationResult)
		OnTravelRequestReceived (name SessionName, lass<OnlineGameSearch> SearchClass, yte PlatformSpecificInfo[80])

Functions Summary
	bool	CancelReservation (UniqueNetId CancellingPartyLeader)
		DestroyBeacon ()
	bool	RequestReservation (const out OnlineGameSearchResult DesiredHost, niqueNetId RequestingPartyLeader, onst out array<PlayerReservation> Players)
	bool	RequestReservationUpdate (const out OnlineGameSearchResult DesiredHost, niqueNetId RequestingPartyLeader, onst out array<PlayerReservation> PlayersToAdd)

ClientBeaconRequestType Source code

The pending request to be sent

ClientBeaconState Source code

The state of the client beacon

HostPendingRequest Source code

Holds a reference to the data that is used to reach the potential host

PendingRequest Source code

The request to send once the socket is established

ReservationRequestElapsedTime Source code

Used to track how long we've been waiting for a response

ReservationRequestTimeout Source code

Indicates how long the client should wait for a response before timing out and trying a new server

Resolver Source code

Platform specific address resolver for this beacon. Instantiated using the ResolverClass type.

ResolverClass Source code

Class to use for address resolving and registering

ResolverClassName Source code

Name of the class to use for address resolving and registering

EPartyBeaconClientRequest Source code

Determine the pending request to be sent to the host

EPartyBeaconClientState Source code

Used to drive the client state machine

OnHostHasCancelled Source code

Called by the beacon when the host sends the "cancellation" packet, so the client can return to finding a new host

OnHostIsReady Source code

Called by the beacon when the host sends the "ready" packet, so the client can connect to the host to start the match

OnReservationCountUpdated Source code

Called by the beacon when the host sends a reservation count update packet so that any UI can be updated
@param ReservationRemaining the number of reservations that are still available

OnReservationRequestComplete Source code

Called by the beacon when a reservation request has been responded to by the destination host
@param ReservationResult whether there was space allocated for the party or not

OnTravelRequestReceived Source code

Called by the beacon when the host sends a request for all clients to travel to the destination included in the packet
@param SessionName the name of the session to register
@param SearchClass the search that should be populated with the session
@param PlatformSpecificInfo the binary data to place in the platform specific areas

CancelReservation Source code

Sends a cancellation message to the remote host so that it knows there is more space available
@param CancellingPartyLeader the leader of this party that wants to cancel
@return true if the request able to be sent, false if it failed to send

DestroyBeacon Source code

Stops listening for requests/responses and releases any allocated memory

RequestReservation Source code

Sends a request to the remote host to allow the specified members to reserve space in the host's session. Note this request is async and the results will be sent via the delegate
@param DesiredHost the server that the connection will be made to
@param RequestingPartyLeader the leader of this party that will be joining
@param Players the list of players that want to reserve space
@return true if the request able to be sent, false if it failed to send

RequestReservationUpdate Source code

Sends a request to the remote host to update an existing reservation for the specified party leader. Any new players not already in the party leader's reservation will be added to that reservation on the host. Host sends a EPartyReservationResult back.
@param DesiredHost the server that the connection will be made to
@param RequestingPartyLeader party leader that will be updating his existing reservation
@param PlayersToAdd the list of players that want to reserve space in an existing reservation
@return true if the request able to be sent, false if it failed to send