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