games  v1
Public Member Functions | Static Public Member Functions | List of all members
google_games_api::RoomP2PStatus Class Reference

#include <room_p2_ps_tatus.h>

Inheritance diagram for google_games_api::RoomP2PStatus:

Public Member Functions

 RoomP2PStatus (const Json::Value &storage)
 
 RoomP2PStatus (Json::Value *storage)
 
virtual ~RoomP2PStatus ()
 
const StringPiece GetTypeName () const
 
bool has_connection_setup_latency_millis () const
 
void clear_connection_setup_latency_millis ()
 
int32 get_connection_setup_latency_millis () const
 
void set_connection_setup_latency_millis (int32 value)
 
bool has_error () const
 
void clear_error ()
 
const StringPiece get_error () const
 
void set_error (const StringPiece &value)
 
bool has_error_reason () const
 
void clear_error_reason ()
 
const StringPiece get_error_reason () const
 
void set_error_reason (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_participant_id () const
 
void clear_participant_id ()
 
const StringPiece get_participant_id () const
 
void set_participant_id (const StringPiece &value)
 
bool has_status () const
 
void clear_status ()
 
const StringPiece get_status () const
 
void set_status (const StringPiece &value)
 
bool has_unreliable_roundtrip_latency_millis () const
 
void clear_unreliable_roundtrip_latency_millis ()
 
int32 get_unreliable_roundtrip_latency_millis () const
 
void set_unreliable_roundtrip_latency_millis (int32 value)
 

Static Public Member Functions

static RoomP2PStatusNew ()
 

Detailed Description

This is a JSON template for an update on the status of a peer in a room.

Constructor & Destructor Documentation

◆ RoomP2PStatus() [1/2]

google_games_api::RoomP2PStatus::RoomP2PStatus ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ RoomP2PStatus() [2/2]

google_games_api::RoomP2PStatus::RoomP2PStatus ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~RoomP2PStatus()

google_games_api::RoomP2PStatus::~RoomP2PStatus ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_connection_setup_latency_millis()

void google_games_api::RoomP2PStatus::clear_connection_setup_latency_millis ( )
inline

Clears the 'connectionSetupLatencyMillis' attribute.

◆ clear_error()

void google_games_api::RoomP2PStatus::clear_error ( )
inline

Clears the 'error' attribute.

◆ clear_error_reason()

void google_games_api::RoomP2PStatus::clear_error_reason ( )
inline

Clears the 'error_reason' attribute.

◆ clear_kind()

void google_games_api::RoomP2PStatus::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_participant_id()

void google_games_api::RoomP2PStatus::clear_participant_id ( )
inline

Clears the 'participantId' attribute.

◆ clear_status()

void google_games_api::RoomP2PStatus::clear_status ( )
inline

Clears the 'status' attribute.

◆ clear_unreliable_roundtrip_latency_millis()

void google_games_api::RoomP2PStatus::clear_unreliable_roundtrip_latency_millis ( )
inline

Clears the 'unreliableRoundtripLatencyMillis' attribute.

◆ get_connection_setup_latency_millis()

int32 google_games_api::RoomP2PStatus::get_connection_setup_latency_millis ( ) const
inline

Get the value of the 'connectionSetupLatencyMillis' attribute.

◆ get_error()

const StringPiece google_games_api::RoomP2PStatus::get_error ( ) const
inline

Get the value of the 'error' attribute.

◆ get_error_reason()

const StringPiece google_games_api::RoomP2PStatus::get_error_reason ( ) const
inline

Get the value of the 'error_reason' attribute.

◆ get_kind()

const StringPiece google_games_api::RoomP2PStatus::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_participant_id()

const StringPiece google_games_api::RoomP2PStatus::get_participant_id ( ) const
inline

Get the value of the 'participantId' attribute.

◆ get_status()

const StringPiece google_games_api::RoomP2PStatus::get_status ( ) const
inline

Get the value of the 'status' attribute.

◆ get_unreliable_roundtrip_latency_millis()

int32 google_games_api::RoomP2PStatus::get_unreliable_roundtrip_latency_millis ( ) const
inline

Get the value of the 'unreliableRoundtripLatencyMillis' attribute.

◆ GetTypeName()

const StringPiece google_games_api::RoomP2PStatus::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_games_api::RoomP2PStatus

◆ has_connection_setup_latency_millis()

bool google_games_api::RoomP2PStatus::has_connection_setup_latency_millis ( ) const
inline

Determine if the 'connectionSetupLatencyMillis' attribute was set.

Returns
true if the 'connectionSetupLatencyMillis' attribute was set.

◆ has_error()

bool google_games_api::RoomP2PStatus::has_error ( ) const
inline

Determine if the 'error' attribute was set.

Returns
true if the 'error' attribute was set.

◆ has_error_reason()

bool google_games_api::RoomP2PStatus::has_error_reason ( ) const
inline

Determine if the 'error_reason' attribute was set.

Returns
true if the 'error_reason' attribute was set.

◆ has_kind()

bool google_games_api::RoomP2PStatus::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_participant_id()

bool google_games_api::RoomP2PStatus::has_participant_id ( ) const
inline

Determine if the 'participantId' attribute was set.

Returns
true if the 'participantId' attribute was set.

◆ has_status()

bool google_games_api::RoomP2PStatus::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ has_unreliable_roundtrip_latency_millis()

bool google_games_api::RoomP2PStatus::has_unreliable_roundtrip_latency_millis ( ) const
inline

Determine if the 'unreliableRoundtripLatencyMillis' attribute was set.

Returns
true if the 'unreliableRoundtripLatencyMillis' attribute was set.

◆ New()

RoomP2PStatus * google_games_api::RoomP2PStatus::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_connection_setup_latency_millis()

void google_games_api::RoomP2PStatus::set_connection_setup_latency_millis ( int32  value)
inline

Change the 'connectionSetupLatencyMillis' attribute.

The amount of time in milliseconds it took to establish connections with this peer.

Parameters
[in]valueThe new value.

◆ set_error()

void google_games_api::RoomP2PStatus::set_error ( const StringPiece &  value)
inline

Change the 'error' attribute.

The error code in event of a failure. Possible values are:

"P2P_FAILED"
The client failed to establish a P2P connection with the peer.
"PRESENCE_FAILED"
The client failed to register to receive P2P connections.
"RELAY_SERVER_FAILED"
The client received an error when trying to use the relay server to establish a P2P connection with the peer.
Parameters
[in]valueThe new value.

◆ set_error_reason()

void google_games_api::RoomP2PStatus::set_error_reason ( const StringPiece &  value)
inline

Change the 'error_reason' attribute.

More detailed diagnostic message returned in event of a failure.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_games_api::RoomP2PStatus::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

Uniquely identifies the type of this resource. Value is always the fixed string games::roomP2PStatus.

Parameters
[in]valueThe new value.

◆ set_participant_id()

void google_games_api::RoomP2PStatus::set_participant_id ( const StringPiece &  value)
inline

Change the 'participantId' attribute.

The ID of the participant.

Parameters
[in]valueThe new value.

◆ set_status()

void google_games_api::RoomP2PStatus::set_status ( const StringPiece &  value)
inline

Change the 'status' attribute.

The status of the peer in the room. Possible values are:

"CONNECTION_ESTABLISHED"
The client established a P2P connection with the peer.
"CONNECTION_FAILED"
The client failed to establish directed presence with the peer.
Parameters
[in]valueThe new value.

◆ set_unreliable_roundtrip_latency_millis()

void google_games_api::RoomP2PStatus::set_unreliable_roundtrip_latency_millis ( int32  value)
inline

Change the 'unreliableRoundtripLatencyMillis' attribute.

The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: