io.ably.lib.types

Class ConnectionDetails

java.lang.Object

io.ably.lib.types.ConnectionDetails

public class ConnectionDetails
extends java.lang.Object

Contains any constraints a client should adhere to and provides additional metadata about a Connection, such as if a request to ChannelBase.publish(java.lang.String, java.lang.Object) a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	clientId Contains the client ID assigned to the token.
java.lang.String	connectionKey The connection secret key string that is used to resume a connection and its state.
java.lang.Long	connectionStateTtl The duration that Ably will persist the connection state for when a Realtime client is abruptly disconnected.
java.lang.Long	maxFrameSize Overrides the default maxFrameSize.
java.lang.Long	maxIdleInterval The maximum length of time in milliseconds that the server will allow no activity to occur in the server to client direction.
java.lang.Long	maxInboundRate The maximum allowable number of requests per second from a client or Ably.
java.lang.Long	maxMessageSize The maximum message size is an attribute of an Ably account and enforced by Ably servers.
java.lang.Long	maxOutboundRate
java.lang.String	serverId A unique identifier for the front-end server that the client has connected to.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientId

public java.lang.String clientId

Contains the client ID assigned to the token. If clientId is null or omitted, then the client is prohibited from assuming a clientId in any operations, however if clientId is a wildcard string *, then the client is permitted to assume any clientId. Any other string value for clientId implies that the clientId is both enforced and assumed for all operations from this client.

Spec: RSA12a, CD2a

connectionKey

public java.lang.String connectionKey

The connection secret key string that is used to resume a connection and its state.

Spec: RTN15e, CD2b

serverId

public java.lang.String serverId

A unique identifier for the front-end server that the client has connected to. This server ID is only used for the purposes of debugging.

Spec: CD2g

maxMessageSize

public java.lang.Long maxMessageSize

The maximum message size is an attribute of an Ably account and enforced by Ably servers. maxMessageSize indicates the maximum message size allowed by the Ably account this connection is using.

Spec: CD2c

maxInboundRate

public java.lang.Long maxInboundRate

The maximum allowable number of requests per second from a client or Ably. In the case of a realtime connection, this restriction applies to the number of messages sent, whereas in the case of REST, it is the total number of REST requests per second.

Spec: CD2e

maxOutboundRate

public java.lang.Long maxOutboundRate

maxFrameSize

public java.lang.Long maxFrameSize

Overrides the default maxFrameSize.

Spec: CD2d

maxIdleInterval

public java.lang.Long maxIdleInterval

The maximum length of time in milliseconds that the server will allow no activity to occur in the server to client direction. After such a period of inactivity, the server will send a HEARTBEAT or transport-level ping to the client. If the value is 0, the server will allow arbitrarily-long levels of inactivity.

Spec: CD2h

connectionStateTtl

public java.lang.Long connectionStateTtl

The duration that Ably will persist the connection state for when a Realtime client is abruptly disconnected.

Spec: CD2f, RTN14e, DF1a