Struct rusoto_gamelift::MatchmakingTicket

pub struct MatchmakingTicket {
    pub configuration_name: Option<String>,
    pub end_time: Option<f64>,
    pub estimated_wait_time: Option<i64>,
    pub game_session_connection_info: Option<GameSessionConnectionInfo>,
    pub players: Option<Vec<Player>>,
    pub start_time: Option<f64>,
    pub status: Option<String>,
    pub status_message: Option<String>,
    pub status_reason: Option<String>,
    pub ticket_id: Option<String>,
}

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

Fields

configuration_name: Option<String>

Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

end_time: Option<f64>

Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

estimated_wait_time: Option<i64>

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

game_session_connection_info: Option<GameSessionConnectionInfo>

Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.

players: Option<Vec<Player>>

A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

start_time: Option<f64>

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

status: Option<String>

Current status of the matchmaking request.

• QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

• SEARCHING -- The matchmaking request is currently being processed.

• REQUIRESACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

• PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

• COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

• FAILED -- The matchmaking request was not completed.

• CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.

• TIMEDOUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.

Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

status_message: Option<String>

Additional information about the current status.

status_reason: Option<String>

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

ticket_id: Option<String>

Unique identifier for a matchmaking ticket.

Trait Implementations

impl Clone for MatchmakingTicket

fn clone(&self) -> MatchmakingTicket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for MatchmakingTicket

fn default() -> MatchmakingTicket

Returns the "default value" for a type.

impl PartialEq<MatchmakingTicket> for MatchmakingTicket

fn eq(&self, other: &MatchmakingTicket) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MatchmakingTicket) -> bool

This method tests for !=.

impl Debug for MatchmakingTicket

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MatchmakingTicket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.