Struct rusoto_gamelift::PlayerSession
source · [−]pub struct PlayerSession {
pub creation_time: Option<f64>,
pub dns_name: Option<String>,
pub fleet_arn: Option<String>,
pub fleet_id: Option<String>,
pub game_session_id: Option<String>,
pub ip_address: Option<String>,
pub player_data: Option<String>,
pub player_id: Option<String>,
pub player_session_id: Option<String>,
pub port: Option<i64>,
pub status: Option<String>,
pub termination_time: Option<f64>,
}
Expand description
Represents a player session. Player sessions are created either for a specific game session, or as part of a game session placement or matchmaking request. A player session can represents a reserved player slot in a game session (when status is RESERVED
) or actual player activity in a game session (when status is ACTIVE
). A player session object, including player data, is automatically passed to a game session when the player connects to the game session and is validated. After the game session ends, player sessions information is retained for 30 days and then removed.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
Fields
creation_time: Option<f64>
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
dns_name: Option<String>
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
-
TLS-enabled fleets:
<unique identifier>.<region identifier>.amazongamelift.com
. -
Non-TLS-enabled fleets:
ec2-<unique identifier>.compute.amazonaws.com
. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
fleet_arn: Option<String>
The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.
fleet_id: Option<String>
A unique identifier for the fleet that the player's game session is running on.
game_session_id: Option<String>
A unique identifier for the game session that the player session is connected to.
ip_address: Option<String>
The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.
player_data: Option<String>
Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.
player_id: Option<String>
A unique identifier for a player that is associated with this player session.
player_session_id: Option<String>
A unique identifier for a player session.
port: Option<i64>
Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
status: Option<String>
Current status of the player session.
Possible player session statuses include the following:
-
RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.
-
ACTIVE -- The player has been validated by the server process and is currently connected.
-
COMPLETED -- The player connection has been dropped.
-
TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).
termination_time: Option<f64>
A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
Trait Implementations
sourceimpl Clone for PlayerSession
impl Clone for PlayerSession
sourcefn clone(&self) -> PlayerSession
fn clone(&self) -> PlayerSession
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PlayerSession
impl Debug for PlayerSession
sourceimpl Default for PlayerSession
impl Default for PlayerSession
sourcefn default() -> PlayerSession
fn default() -> PlayerSession
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for PlayerSession
impl<'de> Deserialize<'de> for PlayerSession
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<PlayerSession> for PlayerSession
impl PartialEq<PlayerSession> for PlayerSession
sourcefn eq(&self, other: &PlayerSession) -> bool
fn eq(&self, other: &PlayerSession) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PlayerSession) -> bool
fn ne(&self, other: &PlayerSession) -> bool
This method tests for !=
.
impl StructuralPartialEq for PlayerSession
Auto Trait Implementations
impl RefUnwindSafe for PlayerSession
impl Send for PlayerSession
impl Sync for PlayerSession
impl Unpin for PlayerSession
impl UnwindSafe for PlayerSession
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more