com.google.api.services.games.model

Class RoomP2PStatus

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.RoomP2PStatus

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class RoomP2PStatus
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Game Services API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RoomP2PStatus()

Method Summary

Methods

Modifier and Type	Method and Description
RoomP2PStatus	clone()
java.lang.Integer	getConnectionSetupLatencyMillis() The amount of time in milliseconds it took to establish connections with this peer.
java.lang.String	getError() The error code in event of a failure.
java.lang.String	getErrorReason() More detailed diagnostic message returned in event of a failure.
java.lang.String	getKind() Uniquely identifies the type of this resource.
java.lang.String	getParticipantId() The ID of the participant.
java.lang.String	getStatus() The status of the peer in the room.
java.lang.Integer	getUnreliableRoundtripLatencyMillis() The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.
RoomP2PStatus	set(java.lang.String fieldName, java.lang.Object value)
RoomP2PStatus	setConnectionSetupLatencyMillis(java.lang.Integer connectionSetupLatencyMillis) The amount of time in milliseconds it took to establish connections with this peer.
RoomP2PStatus	setError(java.lang.String error) The error code in event of a failure.
RoomP2PStatus	setErrorReason(java.lang.String errorReason) More detailed diagnostic message returned in event of a failure.
RoomP2PStatus	setKind(java.lang.String kind) Uniquely identifies the type of this resource.
RoomP2PStatus	setParticipantId(java.lang.String participantId) The ID of the participant.
RoomP2PStatus	setStatus(java.lang.String status) The status of the peer in the room.
RoomP2PStatus	setUnreliableRoundtripLatencyMillis(java.lang.Integer unreliableRoundtripLatencyMillis) The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RoomP2PStatus

public RoomP2PStatus()

Method Detail

getConnectionSetupLatencyMillis

public java.lang.Integer getConnectionSetupLatencyMillis()

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

Returns:

value or null for none

setConnectionSetupLatencyMillis

public RoomP2PStatus setConnectionSetupLatencyMillis(java.lang.Integer connectionSetupLatencyMillis)

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

Parameters:

connectionSetupLatencyMillis - connectionSetupLatencyMillis or null for none

getError

public java.lang.String getError()

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.

Returns:

value or null for none

setError

public RoomP2PStatus setError(java.lang.String error)

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:

error - error or null for none

getErrorReason

public java.lang.String getErrorReason()

More detailed diagnostic message returned in event of a failure.

Returns:

value or null for none

setErrorReason

public RoomP2PStatus setErrorReason(java.lang.String errorReason)

More detailed diagnostic message returned in event of a failure.

Parameters:

errorReason - errorReason or null for none

getKind

public java.lang.String getKind()

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

Returns:

value or null for none

setKind

public RoomP2PStatus setKind(java.lang.String kind)

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

Parameters:

kind - kind or null for none

getParticipantId

public java.lang.String getParticipantId()

The ID of the participant.

Returns:

value or null for none

setParticipantId

public RoomP2PStatus setParticipantId(java.lang.String participantId)

The ID of the participant.

Parameters:

participantId - participantId or null for none

getStatus

public java.lang.String getStatus()

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.

Returns:

value or null for none

setStatus

public RoomP2PStatus setStatus(java.lang.String status)

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:

status - status or null for none

getUnreliableRoundtripLatencyMillis

public java.lang.Integer getUnreliableRoundtripLatencyMillis()

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

Returns:

value or null for none

setUnreliableRoundtripLatencyMillis

public RoomP2PStatus setUnreliableRoundtripLatencyMillis(java.lang.Integer unreliableRoundtripLatencyMillis)

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

Parameters:

unreliableRoundtripLatencyMillis - unreliableRoundtripLatencyMillis or null for none

set

public RoomP2PStatus set(java.lang.String fieldName,
                java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RoomP2PStatus clone()

Overrides:

clone in class com.google.api.client.json.GenericJson