org.eclipse.jetty.websocket.common.io

Class IOState

java.lang.Object

org.eclipse.jetty.websocket.common.io.IOState

public class IOState
extends Object

Simple state tracker for Input / Output and ConnectionState.

Use the various known .on*() methods to trigger a state change.

• onOpened() - connection has been opened

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IOState.ConnectionStateListener

Constructor Summary

Constructors

Constructor and Description
IOState() Create a new IOState, initialized to ConnectionState.CONNECTING

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(IOState.ConnectionStateListener listener)
void	assertInputOpen()
void	assertOutputOpen()
CloseInfo	getCloseInfo()
ConnectionState	getConnectionState()
boolean	isClosed()
boolean	isInputAvailable()
boolean	isOpen()
boolean	isOutputAvailable()
void	onAbnormalClose(CloseInfo close) A websocket connection has been disconnected for abnormal close reasons.
void	onCloseLocal(CloseInfo close) A close handshake has been issued from the local endpoint
void	onCloseRemote(CloseInfo close) A close handshake has been received from the remote endpoint
void	onConnected() WebSocket has successfully upgraded, but the end-user onOpen call hasn't run yet.
void	onDisconnected()
void	onFailedUpgrade() A websocket connection has failed its upgrade handshake, and is now closed.
void	onOpened() A websocket connection has finished its upgrade handshake, and is now open.
void	onReadFailure(Throwable t) The local endpoint has reached a read failure.
void	onWriteFailure(Throwable t) The local endpoint has reached a write failure.
String	toString()
boolean	wasAbnormalClose()
boolean	wasCleanClose()
boolean	wasLocalCloseInitiated()
boolean	wasRemoteCloseInitiated()

Methods inherited from class java.lang.Object

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

Constructor Detail

IOState

public IOState()

Create a new IOState, initialized to ConnectionState.CONNECTING

Method Detail

addListener

public void addListener(IOState.ConnectionStateListener listener)

assertInputOpen

public void assertInputOpen()
                     throws IOException

Throws:

IOException

assertOutputOpen

public void assertOutputOpen()
                      throws IOException

Throws:

IOException

getCloseInfo

public CloseInfo getCloseInfo()

getConnectionState

public ConnectionState getConnectionState()

isClosed

public boolean isClosed()

isInputAvailable

public boolean isInputAvailable()

isOpen

public boolean isOpen()

isOutputAvailable

public boolean isOutputAvailable()

onAbnormalClose

public void onAbnormalClose(CloseInfo close)

A websocket connection has been disconnected for abnormal close reasons.

This is the low level disconnect of the socket. It could be the result of a normal close operation, from an IO error, or even from a timeout.

onCloseLocal

public void onCloseLocal(CloseInfo close)

A close handshake has been issued from the local endpoint

onCloseRemote

public void onCloseRemote(CloseInfo close)

A close handshake has been received from the remote endpoint

onConnected

public void onConnected()

WebSocket has successfully upgraded, but the end-user onOpen call hasn't run yet.

This is an intermediate state between the RFC's ConnectionState.CONNECTING and ConnectionState.OPEN

onFailedUpgrade

public void onFailedUpgrade()

A websocket connection has failed its upgrade handshake, and is now closed.

onOpened

public void onOpened()

A websocket connection has finished its upgrade handshake, and is now open.

onReadFailure

public void onReadFailure(Throwable t)

The local endpoint has reached a read failure.

This could be a normal result after a proper close handshake, or even a premature close due to a connection disconnect.

onWriteFailure

public void onWriteFailure(Throwable t)

The local endpoint has reached a write failure.

A low level I/O failure, or even a jetty side EndPoint close (from idle timeout) are a few scenarios

onDisconnected

public void onDisconnected()

toString

public String toString()

Overrides:

toString in class Object

wasAbnormalClose

public boolean wasAbnormalClose()

wasCleanClose

public boolean wasCleanClose()

wasLocalCloseInitiated

public boolean wasLocalCloseInitiated()

wasRemoteCloseInitiated

public boolean wasRemoteCloseInitiated()