org.igniterealtime.jbosh

Class BOSHClientConnEvent

java.lang.Object

java.util.EventObject

org.igniterealtime.jbosh.BOSHClientConnEvent

All Implemented Interfaces:

Serializable

public final class BOSHClientConnEvent
extends EventObject

Client connection event, notifying of changes in connection state.

This class is immutable and thread-safe.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
BOSHClient	getBOSHClient() Gets the client from which this event originated.
Throwable	getCause() Returns the underlying cause of the error condition.
List<ComposableBody>	getOutstandingRequests() Get the list of requests which may not have been sent or were not acknowledged by the remote connection manager prior to session termination.
boolean	isConnected() Returns whether or not the session has been successfully established and is currently active.
boolean	isError() Returns whether or not this event indicates an error condition.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Method Detail

getBOSHClient

public BOSHClient getBOSHClient()

Gets the client from which this event originated.

Returns:

client instance

isConnected

public boolean isConnected()

Returns whether or not the session has been successfully established and is currently active.

Returns:

true if a session is active, false otherwise

isError

public boolean isError()

Returns whether or not this event indicates an error condition. This will never return true when isConnected() returns true.

Returns:

true if the event indicates a terminal error has occurred, false otherwise.

getCause

public Throwable getCause()

Returns the underlying cause of the error condition. This method is guaranteed to return null when @{code isError()} returns false. Similarly, this method is guaranteed to return non-@{code null} if isError() returns true.

Returns:

underlying cause of the error condition, or null if this event does not represent an error condition

getOutstandingRequests

public List<ComposableBody> getOutstandingRequests()

Get the list of requests which may not have been sent or were not acknowledged by the remote connection manager prior to session termination.

Returns:

list of messages which may not have been received by the remote connection manager, or an empty list if the session is still connected