Package 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

The top-level class to be instanced for the Ably Realtime library. 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	Description
static interface	AblyRealtime.Channels	A collection of Channels associated with this Ably Realtime instance.

Field Summary

Fields

Modifier and Type	Field	Description
AblyRealtime.Channels	channels
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	Description
AblyRealtime(ClientOptions options)	Instance the Ably library with the given options.
AblyRealtime(java.lang.String key)	Instance the Ably library using a key only.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this instance.
void	connect()	Initiate a connection.
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.

channels

public final AblyRealtime.Channels channels

Constructor Detail

AblyRealtime

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

Instance the Ably library using a key only. This is simply a convenience constructor for the simplest case of instancing the library with a key for basic authentication and no other options.

Parameters:

key - String key (obtained from application dashboard)

Throws:

AblyException

AblyRealtime

public AblyRealtime(ClientOptions options)
             throws AblyException

Instance the Ably library with the given options.

Parameters:

options - see ClientOptions for options

Throws:

AblyException

Method Detail

connect

public void connect()

Initiate a connection. Connection.connect().

close

public void close()

Close this instance. This closes the connection. The connection can be re-opened by calling Connection.connect().

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