io.ably.lib.types

Class ClientOptions

java.lang.Object

io.ably.lib.rest.Auth.AuthOptions

io.ably.lib.types.ClientOptions

Direct Known Subclasses:

DebugOptions

public class ClientOptions
extends Auth.AuthOptions

Options: Ably library options for REST and Realtime APIs

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoConnect If false, suppresses the automatic initiation of a connection when the library is instanced.
java.lang.String	clientId The id of the client represented by this instance.
boolean	echoMessages If false, suppresses messages originating from this connection being echoed back on the same connection.
java.util.Map<java.lang.String,java.lang.String>	headers FIXME: unused
Log.LogHandler	logHandler Log handler: allows the client to intercept log messages and handle them in a client-specific way.
int	logLevel Log level; controls the level of verbosity of log messages from the library.
int	port For development environments only; allows a non-default Ably port to be specified.
boolean	queueMessages If false, suppresses the default queueing of messages when connection states that anticipate imminent connection (connecting and disconnected).
java.lang.String	realtimeHost For development environments only; allows a non-default Ably host to be specified for websocket connections.
java.lang.String	recover A connection recovery string, specified by a client when initialising the library with the intention of inheriting the state of an earlier connection.
java.lang.String	restHost For development environments only; allows a non-default Ably host to be specified.
boolean	tls Encrypted transport: if true, TLS will be used for all connections (whether REST/HTTP or Realtime WebSocket or Comet connections).
int	tlsPort For development environments only; allows a non-default Ably TLS port to be specified.
boolean	useBinaryProtocol If false, forces the library to use the JSON encoding for REST and Realtime operations, instead of the default binary msgpack encoding.

Fields inherited from class io.ably.lib.rest.Auth.AuthOptions

authCallback, authHeaders, authParams, authUrl, key, queryTime, token, tokenDetails

Constructor Summary

Constructors

Constructor and Description
ClientOptions() Default constructor
ClientOptions(java.lang.String key) Construct an options with a single key string.

Method Summary

Methods inherited from class io.ably.lib.rest.Auth.AuthOptions

merge

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

The id of the client represented by this instance. The clientId is relevant to presence operations, where the clientId is the principal identifier of the client in presence update messages. The clientId is also relevant to authentication; a token issued for a specific client may be used to authenticate the bearer of that token to the service.

logLevel

public int logLevel

Log level; controls the level of verbosity of log messages from the library.

logHandler

public Log.LogHandler logHandler

Log handler: allows the client to intercept log messages and handle them in a client-specific way.

tls

public boolean tls

Encrypted transport: if true, TLS will be used for all connections (whether REST/HTTP or Realtime WebSocket or Comet connections).

headers

public java.util.Map<java.lang.String,java.lang.String> headers

FIXME: unused

restHost

public java.lang.String restHost

For development environments only; allows a non-default Ably host to be specified.

realtimeHost

public java.lang.String realtimeHost

For development environments only; allows a non-default Ably host to be specified for websocket connections.

port

public int port

For development environments only; allows a non-default Ably port to be specified.

tlsPort

public int tlsPort

For development environments only; allows a non-default Ably TLS port to be specified.

autoConnect

public boolean autoConnect

If false, suppresses the automatic initiation of a connection when the library is instanced.

useBinaryProtocol

public boolean useBinaryProtocol

If false, forces the library to use the JSON encoding for REST and Realtime operations, instead of the default binary msgpack encoding.

queueMessages

public boolean queueMessages

If false, suppresses the default queueing of messages when connection states that anticipate imminent connection (connecting and disconnected). Instead, publish and presence state changes will fail immediately if not in the connected state.

echoMessages

public boolean echoMessages

If false, suppresses messages originating from this connection being echoed back on the same connection.

recover

public java.lang.String recover

A connection recovery string, specified by a client when initialising the library with the intention of inheriting the state of an earlier connection. See the Ably Realtime API documentation for further information on connection state recovery.

Constructor Detail

ClientOptions

public ClientOptions()

Default constructor

ClientOptions

public ClientOptions(java.lang.String key)
              throws AblyException

Construct an options with a single key string. The key string is obtained from the application dashboard.

Parameters:

key: - the key string

Throws:

AblyException - if the key is not in a valid format