Class: Google::Apis::GamesV1::RoomP2PStatus
- Inherits:
-
Object
- Object
- Google::Apis::GamesV1::RoomP2PStatus
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/games_v1/classes.rb,
generated/google/apis/games_v1/representations.rb,
generated/google/apis/games_v1/representations.rb
Overview
This is a JSON template for an update on the status of a peer in a room.
Instance Attribute Summary collapse
-
#connection_setup_latency_millis ⇒ Fixnum
The amount of time in milliseconds it took to establish connections with this peer.
-
#error ⇒ String
The error code in event of a failure.
-
#error_reason ⇒ String
More detailed diagnostic message returned in event of a failure.
-
#kind ⇒ String
Uniquely identifies the type of this resource.
-
#participant_id ⇒ String
The ID of the participant.
-
#status ⇒ String
The status of the peer in the room.
-
#unreliable_roundtrip_latency_millis ⇒ Fixnum
The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RoomP2PStatus
constructor
A new instance of RoomP2PStatus.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ RoomP2PStatus
Returns a new instance of RoomP2PStatus
3657 3658 3659 |
# File 'generated/google/apis/games_v1/classes.rb', line 3657 def initialize(**args) update!(**args) end |
Instance Attribute Details
#connection_setup_latency_millis ⇒ Fixnum
The amount of time in milliseconds it took to establish connections with this
peer.
Corresponds to the JSON property connectionSetupLatencyMillis
3611 3612 3613 |
# File 'generated/google/apis/games_v1/classes.rb', line 3611 def connection_setup_latency_millis @connection_setup_latency_millis end |
#error ⇒ String
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. Corresponds to the JSON property
error
3623 3624 3625 |
# File 'generated/google/apis/games_v1/classes.rb', line 3623 def error @error end |
#error_reason ⇒ String
More detailed diagnostic message returned in event of a failure.
Corresponds to the JSON property error_reason
3628 3629 3630 |
# File 'generated/google/apis/games_v1/classes.rb', line 3628 def error_reason @error_reason end |
#kind ⇒ String
Uniquely identifies the type of this resource. Value is always the fixed
string games#roomP2PStatus.
Corresponds to the JSON property kind
3634 3635 3636 |
# File 'generated/google/apis/games_v1/classes.rb', line 3634 def kind @kind end |
#participant_id ⇒ String
The ID of the participant.
Corresponds to the JSON property participantId
3639 3640 3641 |
# File 'generated/google/apis/games_v1/classes.rb', line 3639 def participant_id @participant_id end |
#status ⇒ String
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.
Corresponds to the JSON property
status
3649 3650 3651 |
# File 'generated/google/apis/games_v1/classes.rb', line 3649 def status @status end |
#unreliable_roundtrip_latency_millis ⇒ Fixnum
The amount of time in milliseconds it took to send packets back and forth on
the unreliable channel with this peer.
Corresponds to the JSON property unreliableRoundtripLatencyMillis
3655 3656 3657 |
# File 'generated/google/apis/games_v1/classes.rb', line 3655 def unreliable_roundtrip_latency_millis @unreliable_roundtrip_latency_millis end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3662 3663 3664 3665 3666 3667 3668 3669 3670 |
# File 'generated/google/apis/games_v1/classes.rb', line 3662 def update!(**args) @connection_setup_latency_millis = args[:connection_setup_latency_millis] if args.key?(:connection_setup_latency_millis) @error = args[:error] if args.key?(:error) @error_reason = args[:error_reason] if args.key?(:error_reason) @kind = args[:kind] if args.key?(:kind) @participant_id = args[:participant_id] if args.key?(:participant_id) @status = args[:status] if args.key?(:status) @unreliable_roundtrip_latency_millis = args[:unreliable_roundtrip_latency_millis] if args.key?(:unreliable_roundtrip_latency_millis) end |