File Coverage

blib/lib/Paws/GameLift/PlayerSession.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::PlayerSession;
2 1     1   607 use Moose;
  1         4  
  1         9  
3             has CreationTime => (is => 'ro', isa => 'Str');
4             has FleetId => (is => 'ro', isa => 'Str');
5             has GameSessionId => (is => 'ro', isa => 'Str');
6             has IpAddress => (is => 'ro', isa => 'Str');
7             has PlayerData => (is => 'ro', isa => 'Str');
8             has PlayerId => (is => 'ro', isa => 'Str');
9             has PlayerSessionId => (is => 'ro', isa => 'Str');
10             has Port => (is => 'ro', isa => 'Int');
11             has Status => (is => 'ro', isa => 'Str');
12             has TerminationTime => (is => 'ro', isa => 'Str');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::GameLift::PlayerSession
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::PlayerSession object:
31              
32             $service_obj->Method(Att1 => { CreationTime => $value, ..., TerminationTime => $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::PlayerSession object:
37              
38             $result = $service_obj->Method(...);
39             $result->Att1->CreationTime
40              
41             =head1 DESCRIPTION
42              
43             Properties describing a player session. A player session represents
44             either a player reservation for a game session or actual player
45             activity in a game session. A player session object (including player
46             data) is automatically passed to a game session when the player
47             connects to the game session and is validated.
48              
49             Player-session-related operations include:
50              
51             =over
52              
53             =item *
54              
55             CreatePlayerSession
56              
57             =item *
58              
59             CreatePlayerSessions
60              
61             =item *
62              
63             DescribePlayerSessions
64              
65             =item *
66              
67             Game session placements
68              
69             =over
70              
71             =item *
72              
73             StartGameSessionPlacement
74              
75             =item *
76              
77             DescribeGameSessionPlacement
78              
79             =item *
80              
81             StopGameSessionPlacement
82              
83             =back
84              
85             =back
86              
87              
88             =head1 ATTRIBUTES
89              
90              
91             =head2 CreationTime => Str
92              
93             Time stamp indicating when this data object was created. Format is a
94             number expressed in Unix time as milliseconds (for example
95             "1469498468.057").
96              
97              
98             =head2 FleetId => Str
99              
100             Unique identifier for a fleet that the player's game session is running
101             on.
102              
103              
104             =head2 GameSessionId => Str
105              
106             Unique identifier for the game session that the player session is
107             connected to.
108              
109              
110             =head2 IpAddress => Str
111              
112             IP address of the game session. To connect to a Amazon GameLift game
113             server, an app needs both the IP address and port number.
114              
115              
116             =head2 PlayerData => Str
117              
118             Developer-defined information related to a player. Amazon GameLift does
119             not use this data, so it can be formatted as needed for use in the
120             game.
121              
122              
123             =head2 PlayerId => Str
124              
125             Unique identifier for a player that is associated with this player
126             session.
127              
128              
129             =head2 PlayerSessionId => Str
130              
131             Unique identifier for a player session.
132              
133              
134             =head2 Port => Int
135              
136             Port number for the game session. To connect to a Amazon GameLift
137             server process, an app needs both the IP address and port number.
138              
139              
140             =head2 Status => Str
141              
142             Current status of the player session.
143              
144             Possible player session statuses include the following:
145              
146             =over
147              
148             =item *
149              
150             B<RESERVED> E<ndash> The player session request has been received, but
151             the player has not yet connected to the server process and/or been
152             validated.
153              
154             =item *
155              
156             B<ACTIVE> E<ndash> The player has been validated by the server process
157             and is currently connected.
158              
159             =item *
160              
161             B<COMPLETED> E<ndash> The player connection has been dropped.
162              
163             =item *
164              
165             B<TIMEDOUT> E<ndash> A player session request was received, but the
166             player did not connect and/or was not validated within the time-out
167             limit (60 seconds).
168              
169             =back
170              
171              
172              
173             =head2 TerminationTime => Str
174              
175             Time stamp indicating when this data object was terminated. Format is a
176             number expressed in Unix time as milliseconds (for example
177             "1469498468.057").
178              
179              
180              
181             =head1 SEE ALSO
182              
183             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
184              
185             =head1 BUGS and CONTRIBUTIONS
186              
187             The source code is located here: https://github.com/pplu/aws-sdk-perl
188              
189             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
190              
191             =cut
192