All Classes
| Class | Description |
|---|---|
| AblyBase |
A client that offers a simple stateless API to interact directly with Ably's REST API.
|
| AblyBase.Channels |
A collection of Channels associated with an Ably instance.
|
| AblyException |
An exception type encapsulating an Ably error code
|
| AblyException.HostFailedException | |
| AblyRealtime |
A client that extends the functionality of the
AblyRest and provides additional realtime-specific features. |
| AblyRealtime.Channels |
A collection of Channels associated with this Ably Realtime instance.
|
| AblyRest |
A client that offers a simple stateless API to interact directly with Ably's REST API.
|
| AgentHeaderCreator | |
| AsyncHttpPaginatedQuery | |
| AsyncHttpPaginatedResponse | |
| AsyncHttpPaginatedResponse.Callback |
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
|
| AsyncHttpScheduler |
A HttpScheduler that uses a thread pool to run HTTP operations.
|
| AsyncPaginatedQuery<T> |
An object that encapsulates parameters of a REST query with a paginated response
|
| AsyncPaginatedResult<T> |
A type that represents a page of results from a paginated query.
|
| Auth |
Token-generation and authentication operations for the Ably API.
|
| Auth.AuthMethod |
Authentication methods
|
| Auth.AuthOptions |
Passes authentication-specific properties in authentication requests to Ably.
|
| Auth.AuthUpdateResult |
An interface providing update result for onAuthUpdated
|
| Auth.RenewAuthResult |
An interface providing completion callbackk for renewAuth
|
| Auth.TokenCallback |
An interface implemented by a callback that provides either tokens,
or signed token requests, in response to a request with given token params.
|
| Auth.TokenDetails |
Contains an Ably Token and its associated metadata.
|
| Auth.TokenParams |
Defines the properties of an Ably Token.
|
| Auth.TokenRequest |
Contains the properties of a request for a token to Ably.
|
| Base64Coder |
A Base64 encoder/decoder.
|
| BaseMessage | |
| BasePaginatedQuery<T> |
A paginated query base implementation that can be used sync or asynchronously.
|
| BasePaginatedQuery.ResultRequest<T> |
Wraps a Http.Request
|
| BasePaginatedQuery.ResultRequest.Failed<T> |
A ResultRequest that has already failed due to a previous condition.
|
| BasePaginatedResult<T> |
A type that represents a page of results from a paginated query.
|
| Callback<T> |
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
|
| Callback.Map<T,U> | |
| Capability |
A class representing an Ably Capability, providing
convenience methods to simplify creation of token requests
|
| Channel | |
| Channel | |
| Channel.MessageListener | |
| ChannelBase |
Enables messages to be published and subscribed to.
|
| ChannelBase |
A class representing a Channel in the Ably REST API.
|
| ChannelBase.MessageListener |
An interface whereby a client maybe notified of message on a channel.
|
| ChannelEvent |
Describes the events emitted by a
Channel object. |
| ChannelMode |
Describes the possible flags used to configure client capabilities, using
ChannelOptions. |
| ChannelOptions |
Passes additional properties to a
Channel or Channel object,
such as encryption, ChannelMode and channel parameters. |
| ChannelProperties |
Describes the properties of the channel state.
|
| ChannelState |
Describes the possible states of a
Channel object. |
| ChannelStateListener |
An interface whereby a client may be notified of state changes for a channel.
|
| ChannelStateListener.ChannelStateChange |
Contains state change information emitted by
Channel objects. |
| ChannelStateListener.Filter | |
| ChannelStateListener.Multicaster | |
| ClientOptions |
Passes additional client-specific properties to the
AblyRest or the AblyRealtime. |
| CloseableExecutor | |
| CollectionUtils | |
| CompletionListener |
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
|
| CompletionListener.FromCallback | |
| CompletionListener.Multicaster |
A Multicaster instance is used in the Ably library to manage a list
of client listeners against certain operations.
|
| CompletionListener.ToCallback | |
| Connection |
Enables the management of a connection to Ably.
|
| ConnectionDetails |
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. |
| ConnectionEvent |
Describes the events emitted by a
Connection object. |
| ConnectionManager | |
| ConnectionManager.Channels |
Methods on the channels map owned by the
AblyRealtime instance
which the ConnectionManager needs access to. |
| ConnectionManager.QueuedMessage |
event queueing
|
| ConnectionManager.StateIndication |
a class encapsulating information
associated with a currentState change
request or notification
|
| ConnectionState |
Describes the realtime
Connection object states. |
| ConnectionStateListener |
An interface whereby a client may be notified of state changes for a connection.
|
| ConnectionStateListener.ConnectionStateChange |
Contains
ConnectionState change information emitted by the Connection object. |
| ConnectionStateListener.Filter | |
| ConnectionStateListener.Multicaster | |
| Crypto |
Contains the properties required to configure the encryption of
Message payloads. |
| Crypto.ChannelCipher | Deprecated.
Since version 1.2.11, this interface (which was only ever intended for internal use within this
library) has been replaced by
Crypto.ChannelCipherSet. |
| Crypto.ChannelCipherSet |
Internal; a matching encipher and decipher pair, where both are guaranteed to have been configured with the same
Crypto.CipherParams as each other. |
| Crypto.CipherParams | |
| Crypto.DecryptingChannelCipher |
Internal; a cipher used to decrypt plaintext from ciphertext, for a channel.
|
| Crypto.EncryptingChannelCipher |
Internal; a cipher used to encrypt plaintext to ciphertext, for a channel.
|
| CurrentThreadExecutor | |
| DebugOptions | |
| DebugOptions.RawHttpListener | |
| DebugOptions.RawProtocolListener | |
| DecodingContext | |
| Defaults | |
| DeltaExtras | |
| DeviceDetails |
Contains the properties of a device registered for push notifications.
|
| DeviceDetails.Push |
Contains the details of the push registration of a device.
|
| DeviceDetails.Push.State | |
| ErrorInfo |
A generic Ably error object that contains an Ably-specific status code, and a generic status code.
|
| ErrorResponse | |
| EventEmitter<Event,Listener> |
A generic interface for event registration and delivery used in a number of the types in the Realtime client library.
|
| Experimental |
An annotation indicating an experimental API.
|
| Hosts |
Object to encapsulate primary host name and shuffled fallback host names.
|
| Http |
A high level wrapper of both a sync and an async HttpScheduler.
|
| Http.Execute<Result> | |
| HttpAuth | |
| HttpAuth.Type | |
| HttpConstants | |
| HttpConstants.ContentTypes | |
| HttpConstants.Headers | |
| HttpConstants.Methods | |
| HttpCore |
HttpCore performs authenticated HTTP synchronously.
|
| HttpCore.AuthRequiredException |
Exception signifying that an httpCore request failed with a WWW-Authenticate response
|
| HttpCore.BodyHandler<T> |
Interface for an entity that performs type-specific processing on an httpCore response body
|
| HttpCore.RequestBody |
Interface for an entity that supplies an httpCore request body
|
| HttpCore.Response |
A type encapsulating an httpCore response
|
| HttpCore.ResponseHandler<T> |
Interface for an entity that performs type-specific processing on an httpCore response
|
| HttpHelpers | |
| HttpPaginatedQuery | |
| HttpPaginatedResponse |
A superset of
PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it. |
| HttpScheduler |
HttpScheduler schedules HttpCore operations to an Executor, exposing a generic async API.
|
| HttpUtils |
HttpUtils: utility methods for Http operations
Internal
|
| HttpUtils.ByteArrayRequestBody |
A RequestBody wrapping a byte array
|
| HttpUtils.FormRequestBody | |
| HttpUtils.JsonRequestBody |
A RequestBody wrapping a JSON-serialisable object
|
| InternalMap<K,V> |
A map implemented using a
ConcurrentHashMap. |
| ITransport | |
| ITransport.ConnectListener | |
| ITransport.Factory | |
| ITransport.Mode | |
| ITransport.TransportParams | |
| JavaPlatformAgentProvider | |
| JsonUtils | |
| JsonUtils.JsonUtilsObject | |
| Log | |
| Log.DefaultHandler |
Default log handler class that sends output to System.out.
|
| Log.LogHandler | |
| Message |
Contains an individual message that is sent to, or received from, Ably.
|
| Message.Batch |
Sets the channel names and message contents to
AblyBase.publishBatch(io.ably.lib.types.Message.Batch[], io.ably.lib.types.ChannelOptions). |
| Message.Serializer | |
| MessageDecodeException |
Special AblyException for message decoding problems
|
| MessageExtras | |
| MessageExtras.Serializer | |
| MessageSerializer |
MessageReader: internal
Utility class to convert response bodies in different formats to Message
and Message arrays.
|
| Multicaster<T> |
Collection of members who are listeners, with methods that are safe to be called from any thread.
|
| NetworkConnectivity | |
| NetworkConnectivity.DefaultNetworkConnectivity | |
| NetworkConnectivity.DelegatedNetworkConnectivity | |
| NetworkConnectivity.NetworkConnectivityListener | |
| NonRetriableTokenException |
Implement this marker interface in your exception class if the token auth operation should not be retried.
|
| PaginatedQuery<T> |
An object that encapsulates parameters of a REST query with a paginated response
|
| PaginatedResult<T> |
Contains a page of results for message or presence history, stats, or REST presence requests.
|
| Param |
A class encapsulating a key/value pair
|
| ParamsUtils | |
| Platform | |
| PlatformAgentProvider | |
| Presence |
Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.
|
| Presence.PresenceListener |
An interface allowing a listener to be notified of arrival of a presence message.
|
| PresenceMessage |
A class representing an individual presence update to be sent or received
via the Ably Realtime service.
|
| PresenceMessage.Action |
Describes the possible actions members in the presence set can emit.
|
| PresenceMessage.ActionSerializer | |
| PresenceMessage.Serializer | |
| PresenceSerializer |
PresenceSerializer: internal
Utility class to convert response bodies in different formats to PresenceMessage
and PresenceMessage arrays.
|
| ProtocolMessage |
A message sent and received over the Realtime protocol.
|
| ProtocolMessage.Action | |
| ProtocolMessage.ActionSerializer | |
| ProtocolMessage.AuthDetails |
Contains the token string used to authenticate a client with Ably.
|
| ProtocolMessage.Flag | |
| ProtocolSerializer | |
| ProxyOptions | |
| PublishResponse |
Contains the responses from a
PublishResponse PublishResponse#publish request. |
| Push |
Enables a device to be registered and deregistered from receiving push notifications.
|
| PushBase |
Enables a device to be registered and deregistered from receiving push notifications.
|
| PushBase.Admin | |
| PushBase.ChannelSubscription |
Contains the subscriptions of a device, or a group of devices sharing the same clientId,
has to a channel in order to receive push notifications.
|
| PushBase.ChannelSubscriptions |
Enables device push channel subscriptions.
|
| PushBase.DeviceRegistrations |
Enables the management of push notification registrations with Ably.
|
| ReadOnlyMap<K,V> |
Exposes a subset of the Map interface, providing read only access only, removing mutating interfaces.
|
| SafeSSLSocketFactory |
This is a decorator for the
SSLSocketFactory which modifies the enabled TLS protocols
for each created SSLSocket to only use the protocols which are considered to be safe. |
| Serialisation | |
| Serialisation.FromJsonElement<T> | |
| Serialisation.HttpBodyHandler<T> | |
| Serialisation.HttpResponseHandler<T> | |
| Stats |
Contains application statistics for a specified time interval and time period.
|
| Stats.ConnectionTypes |
Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
|
| Stats.Granularity |
Describes the interval unit over which statistics are gathered.
|
| Stats.MessageCategory | |
| Stats.MessageCount |
Contains the aggregate counts for messages and data transferred.
|
| Stats.MessageTraffic |
Contains a breakdown of summary stats data for traffic over various transport types.
|
| Stats.MessageTypes |
Contains a breakdown of summary stats data for different (channel vs presence) message types.
|
| Stats.ProcessedCount | |
| Stats.ProcessedMessages | |
| Stats.PushedMessages |
Details the stats on push notifications.
|
| Stats.RequestCount |
Contains the aggregate counts for requests made.
|
| Stats.ResourceCount |
Contains the aggregate data for usage of a resource in a specific scope.
|
| StatsReader |
StatsReader: internal
Utility class to convert response bodies in different formats to Stats data.
|
| Storage |
Interface for an entity that supplies key value store
|
| StringUtils | |
| SyncHttpScheduler |
A HttpScheduler that runs everything in the current thread.
|
| TimerUtil | |
| WebSocketTransport | |
| WebSocketTransport.Factory |
public factory API
|