File Coverage

blib/lib/Paws/GameLift/MatchmakingTicket.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::GameLift::MatchmakingTicket;
2 1     1   371 use Moose;
  1         3  
  1         8  
3             has ConfigurationName => (is => 'ro', isa => 'Str');
4             has EndTime => (is => 'ro', isa => 'Str');
5             has EstimatedWaitTime => (is => 'ro', isa => 'Int');
6             has GameSessionConnectionInfo => (is => 'ro', isa => 'Paws::GameLift::GameSessionConnectionInfo');
7             has Players => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::Player]');
8             has StartTime => (is => 'ro', isa => 'Str');
9             has Status => (is => 'ro', isa => 'Str');
10             has StatusMessage => (is => 'ro', isa => 'Str');
11             has StatusReason => (is => 'ro', isa => 'Str');
12             has TicketId => (is => 'ro', isa => 'Str');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::GameLift::MatchmakingTicket
20              
21             =head1 USAGE
22              
23             This class represents one of two things:
24              
25             =head3 Arguments in a call to a service
26              
27             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28             Each attribute should be used as a named argument in the calls that expect this type of object.
29              
30             As an example, if Att1 is expected to be a Paws::GameLift::MatchmakingTicket object:
31              
32             $service_obj->Method(Att1 => { ConfigurationName => $value, ..., TicketId => $value });
33              
34             =head3 Results returned from an API call
35              
36             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::MatchmakingTicket object:
37              
38             $result = $service_obj->Method(...);
39             $result->Att1->ConfigurationName
40              
41             =head1 DESCRIPTION
42              
43             Ticket generated to track the progress of a matchmaking request. Each
44             ticket is uniquely identified by a ticket ID, supplied by the
45             requester, when creating a matchmaking request with StartMatchmaking.
46             Tickets can be retrieved by calling DescribeMatchmaking with the ticket
47             ID.
48              
49             =head1 ATTRIBUTES
50              
51              
52             =head2 ConfigurationName => Str
53              
54             Name of the MatchmakingConfiguration that is used with this ticket.
55             Matchmaking configurations determine how players are grouped into a
56             match and how a new game session is created for the match.
57              
58              
59             =head2 EndTime => Str
60              
61             Time stamp indicating when the matchmaking request stopped being
62             processed due to successful completion, timeout, or cancellation.
63             Format is a number expressed in Unix time as milliseconds (for example
64             "1469498468.057").
65              
66              
67             =head2 EstimatedWaitTime => Int
68              
69             Average amount of time (in seconds) that players are currently waiting
70             for a match. If there is not enough recent data, this property may be
71             empty.
72              
73              
74             =head2 GameSessionConnectionInfo => L<Paws::GameLift::GameSessionConnectionInfo>
75              
76             Identifier and connection information of the game session created for
77             the match. This information is added to the ticket only after the
78             matchmaking request has been successfully completed.
79              
80              
81             =head2 Players => ArrayRef[L<Paws::GameLift::Player>]
82              
83             A set of C<Player> objects, each representing a player to find matches
84             for. Players are identified by a unique player ID and may include
85             latency data for use during matchmaking. If the ticket is in status
86             C<COMPLETED>, the C<Player> objects include the team the players were
87             assigned to in the resulting match.
88              
89              
90             =head2 StartTime => Str
91              
92             Time stamp indicating when this matchmaking request was received.
93             Format is a number expressed in Unix time as milliseconds (for example
94             "1469498468.057").
95              
96              
97             =head2 Status => Str
98              
99             Current status of the matchmaking request.
100              
101             =over
102              
103             =item *
104              
105             B<QUEUED> -- The matchmaking request has been received and is currently
106             waiting to be processed.
107              
108             =item *
109              
110             B<SEARCHING> -- The matchmaking request is currently being processed.
111              
112             =item *
113              
114             B<REQUIRES_ACCEPTANCE> -- A match has been proposed and the players
115             must accept the match (see AcceptMatch). This status is used only with
116             requests that use a matchmaking configuration with a player acceptance
117             requirement.
118              
119             =item *
120              
121             B<PLACING> -- The FlexMatch engine has matched players and is in the
122             process of placing a new game session for the match.
123              
124             =item *
125              
126             B<COMPLETED> -- Players have been matched and a game session is ready
127             to host the players. A ticket in this state contains the necessary
128             connection information for players.
129              
130             =item *
131              
132             B<FAILED> -- The matchmaking request was not completed. Tickets with
133             players who fail to accept a proposed match are placed in C<FAILED>
134             status; new matchmaking requests can be submitted for these players.
135              
136             =item *
137              
138             B<CANCELLED> -- The matchmaking request was canceled with a call to
139             StopMatchmaking.
140              
141             =item *
142              
143             B<TIMED_OUT> -- The matchmaking request was not completed within the
144             duration specified in the matchmaking configuration. Matchmaking
145             requests that time out can be resubmitted.
146              
147             =back
148              
149              
150              
151             =head2 StatusMessage => Str
152              
153             Additional information about the current status.
154              
155              
156             =head2 StatusReason => Str
157              
158             Code to explain the current status. For example, a status reason may
159             indicate when a ticket has returned to C<SEARCHING> status after a
160             proposed match fails to receive player acceptances.
161              
162              
163             =head2 TicketId => Str
164              
165             Unique identifier for a matchmaking ticket.
166              
167              
168              
169             =head1 SEE ALSO
170              
171             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
172              
173             =head1 BUGS and CONTRIBUTIONS
174              
175             The source code is located here: https://github.com/pplu/aws-sdk-perl
176              
177             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
178              
179             =cut
180