org.eclipse.jetty.websocket.common.io

Class AbstractWebSocketConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

org.eclipse.jetty.websocket.common.io.AbstractWebSocketConnection

All Implemented Interfaces:

AutoCloseable, Connection, OutgoingFrames, SuspendToken, IOState.ConnectionStateListener, LogicalConnection

Direct Known Subclasses:

WebSocketClientConnection, WebSocketServerConnection

public abstract class AbstractWebSocketConnection
extends AbstractConnection
implements LogicalConnection, IOState.ConnectionStateListener

Provides the implementation of WebSocketConnection within the framework of the new Connection framework of jetty-io

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWebSocketConnection.Stats

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection

Connection.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.io.AbstractConnection

EXECUTE_ONFILLABLE

Constructor Summary

Constructors

Constructor and Description
AbstractWebSocketConnection(EndPoint endp, Executor executor, Scheduler scheduler, WebSocketPolicy policy, ByteBufferPool bufferPool)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Performs a logical close of this connection.
void	close(int statusCode, String reason) Send a websocket Close frame, with status code.
void	complete(Callback callback)
void	disconnect() Terminate the connection (no close frame sent)
void	disconnect(boolean onlyOutput)
protected void	execute(Runnable task)
void	fillInterested() Utility method to be called to register read interest.
void	flush()
ByteBufferPool	getBufferPool()
List<ExtensionConfig>	getExtensions() Get the list of extensions in use.
Generator	getGenerator()
IOState	getIOState() Get the IOState of the connection.
long	getMaxIdleTimeout() Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
Parser	getParser()
WebSocketPolicy	getPolicy() The policy that the connection is running under.
InetSocketAddress	getRemoteAddress() Get the remote Address in use for this connection.
Scheduler	getScheduler()
WebSocketSession	getSession() Get the Session for this connection
AbstractWebSocketConnection.Stats	getStats()
boolean	isOpen() Test if logical connection is still open
boolean	isReading() Tests if the connection is actively reading.
void	onClose() Physical connection disconnect.
void	onConnectionStateChange(ConnectionState state)
void	onFillable() Callback method invoked when the endpoint is ready to be read.
protected void	onFillInterestedFailed(Throwable cause) Callback method invoked when the endpoint failed to be ready to be read.
void	onOpen() Callback method invoked when this Connection is opened.
protected boolean	onReadTimeout() Callback method invoked when the endpoint failed to be ready to be read after a timeout
void	outgoingFrame(Frame frame, WriteCallback callback) Frame from API, User, or Internal implementation destined for network.
void	resume() Resume a previously suspended connection.
void	setExtensions(List<ExtensionConfig> extensions) Get the list of extensions in use.
void	setInputBufferSize(int inputBufferSize)
void	setMaxIdleTimeout(long ms) Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
void	setSession(WebSocketSession session) Set the session associated with this connection
SuspendToken	suspend() Suspend a the incoming read events on the connection.
String	toString()

Methods inherited from class org.eclipse.jetty.io.AbstractConnection

addListener, block, getBytesIn, getBytesOut, getCreatedTimeStamp, getEndPoint, getExecutor, getInputBufferSize, getMessagesIn, getMessagesOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.websocket.common.LogicalConnection

getLocalAddress, setNextIncomingFrames

Constructor Detail

AbstractWebSocketConnection

public AbstractWebSocketConnection(EndPoint endp,
                           Executor executor,
                           Scheduler scheduler,
                           WebSocketPolicy policy,
                           ByteBufferPool bufferPool)

Method Detail

close

public void close()

Description copied from interface: Connection

Performs a logical close of this connection.

For simple connections, this may just mean to delegate the close to the associated EndPoint but, for example, SSL connections should write the SSL close message before closing the associated EndPoint.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Specified by:

close in interface LogicalConnection

Overrides:

close in class AbstractConnection

See Also:

StatusCode, LogicalConnection.close(int, String)

close

public void close(int statusCode,
         String reason)

Description copied from interface: LogicalConnection

Send a websocket Close frame, with status code.

Advanced usage: results in an non-blocking async write, then connection close.

Specified by:

close in interface LogicalConnection

Parameters:

statusCode - the status code

reason - the (optional) reason. (can be null for no reason)

See Also:

StatusCode

complete

public void complete(Callback callback)

disconnect

public void disconnect()

Description copied from interface: LogicalConnection

Terminate the connection (no close frame sent)

Specified by:

disconnect in interface LogicalConnection

disconnect

public void disconnect(boolean onlyOutput)

execute

protected void execute(Runnable task)

fillInterested

public void fillInterested()

Description copied from class: AbstractConnection

Utility method to be called to register read interest.

After a call to this method, AbstractConnection.onFillable() or AbstractConnection.onFillInterestedFailed(Throwable) will be called back as appropriate.

Overrides:

fillInterested in class AbstractConnection

See Also:

AbstractConnection.onFillable()

flush

public void flush()

getBufferPool

public ByteBufferPool getBufferPool()

getExtensions

public List<ExtensionConfig> getExtensions()

Get the list of extensions in use.

This list is negotiated during the WebSocket Upgrade Request/Response handshake.

Returns:

the list of negotiated extensions in use.

getGenerator

public Generator getGenerator()

getIOState

public IOState getIOState()

Description copied from interface: LogicalConnection

Get the IOState of the connection.

Specified by:

getIOState in interface LogicalConnection

Returns:

the IOState of the connection.

getMaxIdleTimeout

public long getMaxIdleTimeout()

Description copied from interface: LogicalConnection

Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)

Specified by:

getMaxIdleTimeout in interface LogicalConnection

Returns:

the idle timeout in milliseconds

getParser

public Parser getParser()

getPolicy

public WebSocketPolicy getPolicy()

Description copied from interface: LogicalConnection

The policy that the connection is running under.

Specified by:

getPolicy in interface LogicalConnection

Returns:

the policy for the connection

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: LogicalConnection

Get the remote Address in use for this connection.

Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.

Specified by:

getRemoteAddress in interface LogicalConnection

Returns:

the remote address.

getScheduler

public Scheduler getScheduler()

getSession

public WebSocketSession getSession()

Description copied from interface: LogicalConnection

Get the Session for this connection

Specified by:

getSession in interface LogicalConnection

Returns:

the Session for this connection

getStats

public AbstractWebSocketConnection.Stats getStats()

isOpen

public boolean isOpen()

Description copied from interface: LogicalConnection

Test if logical connection is still open

Specified by:

isOpen in interface LogicalConnection

Returns:

true if connection is open

isReading

public boolean isReading()

Description copied from interface: LogicalConnection

Tests if the connection is actively reading.

Specified by:

isReading in interface LogicalConnection

Returns:

true if connection is actively attempting to read.

onClose

public void onClose()

Physical connection disconnect.

Not related to WebSocket close handshake.

Specified by:

onClose in interface Connection

Overrides:

onClose in class AbstractConnection

onConnectionStateChange

public void onConnectionStateChange(ConnectionState state)

Specified by:

onConnectionStateChange in interface IOState.ConnectionStateListener

onFillable

public void onFillable()

Description copied from class: AbstractConnection

Callback method invoked when the endpoint is ready to be read.

Specified by:

onFillable in class AbstractConnection

See Also:

AbstractConnection.fillInterested()

onFillInterestedFailed

protected void onFillInterestedFailed(Throwable cause)

Description copied from class: AbstractConnection

Callback method invoked when the endpoint failed to be ready to be read.

Overrides:

onFillInterestedFailed in class AbstractConnection

Parameters:

cause - the exception that caused the failure

onOpen

public void onOpen()

Description copied from interface: Connection

Callback method invoked when this Connection is opened.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onOpen in interface Connection

Overrides:

onOpen in class AbstractConnection

onReadTimeout

protected boolean onReadTimeout()

Description copied from class: AbstractConnection

Callback method invoked when the endpoint failed to be ready to be read after a timeout

Overrides:

onReadTimeout in class AbstractConnection

Returns:

true to signal that the endpoint must be closed, false to keep the endpoint open

outgoingFrame

public void outgoingFrame(Frame frame,
                 WriteCallback callback)

Frame from API, User, or Internal implementation destined for network.

Specified by:

outgoingFrame in interface OutgoingFrames

Parameters:

frame - the frame to eventually write to the network.

callback - the optional callback to use for success/failure of the network write operation. Can be null.

resume

public void resume()

Description copied from interface: SuspendToken

Resume a previously suspended connection.

Specified by:

resume in interface SuspendToken

setExtensions

public void setExtensions(List<ExtensionConfig> extensions)

Get the list of extensions in use.

This list is negotiated during the WebSocket Upgrade Request/Response handshake.

Parameters:

extensions - the list of negotiated extensions in use.

setInputBufferSize

public void setInputBufferSize(int inputBufferSize)

Overrides:

setInputBufferSize in class AbstractConnection

setMaxIdleTimeout

public void setMaxIdleTimeout(long ms)

Description copied from interface: LogicalConnection

Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)

Specified by:

setMaxIdleTimeout in interface LogicalConnection

Parameters:

ms - the number of milliseconds of idle timeout

setSession

public void setSession(WebSocketSession session)

Description copied from interface: LogicalConnection

Set the session associated with this connection

Specified by:

setSession in interface LogicalConnection

Parameters:

session - the session

suspend

public SuspendToken suspend()

Description copied from interface: LogicalConnection

Suspend a the incoming read events on the connection.

Specified by:

suspend in interface LogicalConnection

Returns:

toString

public String toString()

Overrides:

toString in class AbstractConnection