Package io.ably.lib.realtime

Class ConnectionStateListener.ConnectionStateChange

java.lang.Object

io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange

Enclosing interface:

ConnectionStateListener

public static class ConnectionStateListener.ConnectionStateChange
extends Object

Contains ConnectionState change information emitted by the Connection object.

Field Summary

Fields

Modifier and Type	Field	Description
final ConnectionState	current	The new ConnectionState.
final ConnectionEvent	event	The event that triggered this ConnectionState change.
final ConnectionState	previous	The previous ConnectionState.
final ErrorInfo	reason	An ErrorInfo object containing any information relating to the transition.
final long	retryIn	Duration in milliseconds, after which the client retries a connection where applicable.

Constructor Summary

Constructors

Constructor	Description
ConnectionStateChange(ConnectionState previous, ConnectionState current, long retryIn, ErrorInfo reason)

Method Summary

Modifier and Type	Method	Description
static ConnectionStateListener.ConnectionStateChange	createUpdateEvent(ErrorInfo reason)

Methods inherited from class java.lang.Object

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

Field Details

event

public final ConnectionEvent event

The event that triggered this ConnectionState change.

Spec: TA5

previous

public final ConnectionState previous

The previous ConnectionState. For the ConnectionEvent.update event, this is equal to the current ConnectionState.

Spec: TA2

current

public final ConnectionState current

The new ConnectionState.

Spec: TA2

retryIn

public final long retryIn

Duration in milliseconds, after which the client retries a connection where applicable.

Spec: RTN14d, TA2

reason

public final ErrorInfo reason

An ErrorInfo object containing any information relating to the transition.

Spec: RTN4f, TA3

Constructor Details

ConnectionStateChange

public ConnectionStateChange(ConnectionState previous,
 ConnectionState current,
 long retryIn,
 ErrorInfo reason)

Method Details

createUpdateEvent

public static ConnectionStateListener.ConnectionStateChange createUpdateEvent(ErrorInfo reason)