amazonka-gamelift-1.5.0: Amazon GameLift SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GameLift.AcceptMatch

Contents

Description

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 all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED , and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Matchmaking-related operations include:

  • StartMatchmaking
  • DescribeMatchmaking
  • StopMatchmaking
  • AcceptMatch

Synopsis

Creating a Request

acceptMatch Source #

Creates a value of AcceptMatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • amTicketId - Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE ; otherwise this request will fail.
  • amPlayerIds - Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
  • amAcceptanceType - Player response to the proposed match.

data AcceptMatch Source #

Represents the input for a request action.

See: acceptMatch smart constructor.

Instances

Eq AcceptMatch Source # 
Data AcceptMatch Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AcceptMatch -> c AcceptMatch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AcceptMatch #

toConstr :: AcceptMatch -> Constr #

dataTypeOf :: AcceptMatch -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AcceptMatch) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AcceptMatch) #

gmapT :: (forall b. Data b => b -> b) -> AcceptMatch -> AcceptMatch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AcceptMatch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AcceptMatch -> r #

gmapQ :: (forall d. Data d => d -> u) -> AcceptMatch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AcceptMatch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AcceptMatch -> m AcceptMatch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AcceptMatch -> m AcceptMatch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AcceptMatch -> m AcceptMatch #

Read AcceptMatch Source # 
Show AcceptMatch Source # 
Generic AcceptMatch Source # 

Associated Types

type Rep AcceptMatch :: * -> * #

Hashable AcceptMatch Source # 
ToJSON AcceptMatch Source # 
NFData AcceptMatch Source # 

Methods

rnf :: AcceptMatch -> () #

AWSRequest AcceptMatch Source # 
ToQuery AcceptMatch Source # 
ToPath AcceptMatch Source # 
ToHeaders AcceptMatch Source # 

Methods

toHeaders :: AcceptMatch -> [Header] #

type Rep AcceptMatch Source # 
type Rep AcceptMatch = D1 (MetaData "AcceptMatch" "Network.AWS.GameLift.AcceptMatch" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "AcceptMatch'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_amTicketId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_amPlayerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) (S1 (MetaSel (Just Symbol "_amAcceptanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AcceptanceType)))))
type Rs AcceptMatch Source # 

Request Lenses

amTicketId :: Lens' AcceptMatch Text Source #

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

amPlayerIds :: Lens' AcceptMatch [Text] Source #

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

amAcceptanceType :: Lens' AcceptMatch AcceptanceType Source #

Player response to the proposed match.

Destructuring the Response

acceptMatchResponse Source #

Creates a value of AcceptMatchResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data AcceptMatchResponse Source #

See: acceptMatchResponse smart constructor.

Instances

Eq AcceptMatchResponse Source # 
Data AcceptMatchResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AcceptMatchResponse -> c AcceptMatchResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AcceptMatchResponse #

toConstr :: AcceptMatchResponse -> Constr #

dataTypeOf :: AcceptMatchResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AcceptMatchResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AcceptMatchResponse) #

gmapT :: (forall b. Data b => b -> b) -> AcceptMatchResponse -> AcceptMatchResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AcceptMatchResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AcceptMatchResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AcceptMatchResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AcceptMatchResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AcceptMatchResponse -> m AcceptMatchResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AcceptMatchResponse -> m AcceptMatchResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AcceptMatchResponse -> m AcceptMatchResponse #

Read AcceptMatchResponse Source # 
Show AcceptMatchResponse Source # 
Generic AcceptMatchResponse Source # 
NFData AcceptMatchResponse Source # 

Methods

rnf :: AcceptMatchResponse -> () #

type Rep AcceptMatchResponse Source # 
type Rep AcceptMatchResponse = D1 (MetaData "AcceptMatchResponse" "Network.AWS.GameLift.AcceptMatch" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" True) (C1 (MetaCons "AcceptMatchResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_amrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

amrsResponseStatus :: Lens' AcceptMatchResponse Int Source #

  • - | The response status code.