Struct aws_sdk_gamelift::client::fluent_builders::AcceptMatch

pub struct AcceptMatch<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to AcceptMatch.

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to respond, the ticket status is set to CANCELLED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Implementations

impl<C, M, R> AcceptMatch<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<AcceptMatchOutput, SdkError<AcceptMatchError>> where
    R::Policy: SmithyRetryPolicy<AcceptMatchInputOperationOutputAlias, AcceptMatchOutput, AcceptMatchError, AcceptMatchInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn ticket_id(self, inp: impl Into<String>) -> Self

A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

pub fn set_ticket_id(self, input: Option<String>) -> Self

A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

pub fn player_ids(self, inp: impl Into<String>) -> Self

Appends an item to PlayerIds.

To override the contents of this collection use set_player_ids.

A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

pub fn set_player_ids(self, input: Option<Vec<String>>) -> Self

A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

pub fn acceptance_type(self, inp: AcceptanceType) -> Self

Player response to the proposed match.

pub fn set_acceptance_type(self, input: Option<AcceptanceType>) -> Self

Player response to the proposed match.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for AcceptMatch<C, M, R>

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

Formats the value using the given formatter.