io.ably.lib.realtime

Class AblyRealtime

java.lang.Object

io.ably.lib.rest.AblyBase

io.ably.lib.rest.AblyRest

io.ably.lib.realtime.AblyRealtime

All Implemented Interfaces:

java.lang.AutoCloseable

public class AblyRealtime
extends AblyRest

A client that extends the functionality of the AblyRest and provides additional realtime-specific features. This class implements AutoCloseable so you can use it in try-with-resources constructs and have the JDK close it for you.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AblyRealtime.Channels A collection of Channels associated with this Ably Realtime instance.

Field Summary

Fields

Modifier and Type	Field and Description
AblyRealtime.Channels	channels A AblyRealtime.Channels object.
Connection	connection The Connection object for this instance.

Fields inherited from class io.ably.lib.rest.AblyBase

auth, http, httpCore, options, platform, platformAgentProvider, push

Constructor Summary

Constructors

Constructor and Description
AblyRealtime(ClientOptions options) Constructs a RealtimeClient object using an Ably ClientOptions object.
AblyRealtime(java.lang.String key) Constructs a Realtime client object using an Ably API key or token string.

Method Summary

Modifier and Type	Method and Description
void	close() Calls Connection.close() and causes the connection to close, entering the closing state.
void	connect() Calls Connection.connect() and causes the connection to open, entering the connecting state.
protected void	onAuthError(ErrorInfo errorInfo) Authentication error occurred
protected void	onAuthUpdated(java.lang.String token, boolean waitForResponse) Authentication token has changed.
protected void	onAuthUpdatedAsync(java.lang.String token, Auth.AuthUpdateResult authUpdateResult) Authentication token has changed.

Methods inherited from class io.ably.lib.rest.AblyBase

onClientIdSet, publishBatch, publishBatch, publishBatchAsync, publishBatchAsync, request, requestAsync, stats, statsAsync, time, timeAsync

Methods inherited from class java.lang.Object

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

Field Detail

connection

public final Connection connection

The Connection object for this instance.

Spec: RTC2

channels

public final AblyRealtime.Channels channels

A AblyRealtime.Channels object.

Spec: RTC3, RTS1

Constructor Detail

AblyRealtime

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

Constructs a Realtime client object using an Ably API key or token string.

Spec: RSC1

Parameters:

key - The Ably API key or token string used to validate the client.

Throws:

AblyException

AblyRealtime

public AblyRealtime(ClientOptions options)
             throws AblyException

Constructs a RealtimeClient object using an Ably ClientOptions object.

Spec: RSC1

Parameters:

options - A ClientOptions object.

Throws:

AblyException

Method Detail

connect

public void connect()

Calls Connection.connect() and causes the connection to open, entering the connecting state. Explicitly calling connect() is unnecessary unless the ClientOptions.autoConnect property is disabled.

Spec: RTN11

close

public void close()

Calls Connection.close() and causes the connection to close, entering the closing state. Once closed, the library will not attempt to re-establish the connection without an explicit call to Connection.connect().

Spec: RTN12

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class AblyBase

onAuthUpdated

protected void onAuthUpdated(java.lang.String token,
                             boolean waitForResponse)
                      throws AblyException

Authentication token has changed.

Overrides:

onAuthUpdated in class AblyBase

Parameters:

token - new token

waitForResponse - wait for server response before returning from method

Throws:

AblyException

onAuthUpdatedAsync

protected void onAuthUpdatedAsync(java.lang.String token,
                                  Auth.AuthUpdateResult authUpdateResult)

Authentication token has changed. Async version

Overrides:

onAuthUpdatedAsync in class AblyBase

Parameters:

token - new token

authUpdateResult - Callback result

onAuthError

protected void onAuthError(ErrorInfo errorInfo)

Authentication error occurred

Overrides:

onAuthError in class AblyBase