File Coverage

blib/lib/Paws/GameLift/GameSessionConnectionInfo.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::GameSessionConnectionInfo;
2 1     1   429 use Moose;
  1         2  
  1         7  
3             has GameSessionArn => (is => 'ro', isa => 'Str');
4             has IpAddress => (is => 'ro', isa => 'Str');
5             has MatchedPlayerSessions => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::MatchedPlayerSession]');
6             has Port => (is => 'ro', isa => 'Int');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::GameLift::GameSessionConnectionInfo
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::GameLift::GameSessionConnectionInfo object:
25              
26             $service_obj->Method(Att1 => { GameSessionArn => $value, ..., Port => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameSessionConnectionInfo object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->GameSessionArn
34              
35             =head1 DESCRIPTION
36              
37             Connection information for the new game session that is created with
38             matchmaking. (with StartMatchmaking). Once a match is set, the
39             FlexMatch engine places the match and creates a new game session for
40             it. This information, including the game session endpoint and player
41             sessions for each player in the original matchmaking request, is added
42             to the MatchmakingTicket, which can be retrieved by calling
43             DescribeMatchmaking.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 GameSessionArn => Str
49              
50             Amazon Resource Name (ARN) that is assigned to a game session and
51             uniquely identifies it.
52              
53              
54             =head2 IpAddress => Str
55              
56             IP address of the game session. To connect to a Amazon GameLift game
57             server, an app needs both the IP address and port number.
58              
59              
60             =head2 MatchedPlayerSessions => ArrayRef[L<Paws::GameLift::MatchedPlayerSession>]
61              
62             Collection of player session IDs, one for each player ID that was
63             included in the original matchmaking request.
64              
65              
66             =head2 Port => Int
67              
68             Port number for the game session. To connect to a Amazon GameLift game
69             server, an app needs both the IP address and port number.
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84