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:

Closeable, AutoCloseable, Connection, Connection.UpgradeTo, Dumpable, OutgoingFrames, SuspendToken, LogicalConnection

Direct Known Subclasses:

WebSocketClientConnection, WebSocketServerConnection

public abstract class AbstractWebSocketConnection
extends AbstractConnection
implements LogicalConnection, Connection.UpgradeTo, Dumpable

Provides the implementation of LogicalConnection 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 Deprecated.

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

Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canReadWebSocketFrames() Test if Connection State allows for reading of frames.
boolean	canWriteWebSocketFrames() Test if Connection State allows for writing frames.
void	close() Jetty Connection Close
void	close(CloseInfo close, Callback callback) Request a local close.
void	close(Throwable cause) Close the connection based on the throwable
void	disconnect() Terminate the connection (no close frame sent)
void	dump(Appendable out, String indent) Dump this object (and children) into an Appendable using the provided indent after any new lines.
String	dumpSelf() The description of this/self found in the dump.
void	fillInterested() Utility method to be called to register read interest.
ByteBufferPool	getBufferPool() Get the ByteBufferPool in use by the connection
long	getBytesIn()
long	getBytesOut()
Executor	getExecutor() Get the Executor used by this connection.
List<ExtensionConfig>	getExtensions() Get the list of extensions in use.
Generator	getGenerator()
String	getId() Get Unique ID for the Connection
long	getIdleTimeout() Get the read/write idle timeout.
InetSocketAddress	getLocalAddress() Get the local InetSocketAddress in use for this 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)
long	getMessagesIn()
long	getMessagesOut()
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()
AbstractWebSocketConnection.Stats	getStats() Deprecated.
boolean	isOpen() Test if logical connection is still open
boolean	isReading() Tests if the connection is actively reading.
void	onFillable() Callback method invoked when the endpoint is ready to be read.
boolean	onIdleExpired() Callback method invoked upon an idle timeout event.
void	onUpgradeTo(ByteBuffer prefilled) Extra bytes from the initial HTTP upgrade that need to be processed by the websocket parser before starting to read bytes from the connection
boolean	opened() Set the state to opened (the application onOpen() method has been called successfully).
boolean	opening() Set the state to upgrade/opening handshake has completed.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode) Frame from API, User, or Internal implementation destined for network.
void	remoteClose(CloseInfo close) Report that the Remote Endpoint CLOSE Frame has been received
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	setNextIncomingFrames(IncomingFrames incoming) Set where the connection should send the incoming frames to.
void	setSession(WebSocketSession session) Associate the Active Session with the connection.
SuspendToken	suspend() Suspend a the incoming read events on the connection.
String	toConnectionString()
String	toStateString() Get the Connection State as a String

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

addListener, getCreatedTimeStamp, getEndPoint, getInputBufferSize, isFillInterested, onClose, onOpen, removeListener, toString, tryFillInterested, tryFillInterested

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dump, dumpContainer, dumpIterable, dumpMapEntries, dumpObject, dumpObjects, named

Constructor Detail

AbstractWebSocketConnection

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

Method Detail

getExecutor

public Executor getExecutor()

Description copied from interface: LogicalConnection

Get the Executor used by this connection.

Specified by:

getExecutor in interface LogicalConnection

Returns:

the executor

close

public void close(CloseInfo close,
                  Callback callback)

Description copied from interface: LogicalConnection

Request a local close.

Specified by:

close in interface LogicalConnection

close

public void close(Throwable cause)

Close the connection based on the throwable

Specified by:

close in interface LogicalConnection

Parameters:

cause - the cause

canWriteWebSocketFrames

public boolean canWriteWebSocketFrames()

Description copied from interface: LogicalConnection

Test if Connection State allows for writing frames.

Specified by:

canWriteWebSocketFrames in interface LogicalConnection

Returns:

true if able to write, false otherwise.

canReadWebSocketFrames

public boolean canReadWebSocketFrames()

Description copied from interface: LogicalConnection

Test if Connection State allows for reading of frames.

Specified by:

canReadWebSocketFrames in interface LogicalConnection

Returns:

true if able to read, false otherwise.

toStateString

public String toStateString()

Description copied from interface: LogicalConnection

Get the Connection State as a String

Specified by:

toStateString in interface LogicalConnection

Returns:

the Connection State string

opening

public boolean opening()

Description copied from interface: LogicalConnection

Set the state to upgrade/opening handshake has completed.

Specified by:

opening in interface LogicalConnection

Returns:

true if state is OPENING, false otherwise

opened

public boolean opened()

Description copied from interface: LogicalConnection

Set the state to opened (the application onOpen() method has been called successfully).

Reads from network begin here.

Specified by:

opened in interface LogicalConnection

Returns:

true if state is OPENED, false otherwise

remoteClose

public void remoteClose(CloseInfo close)

Description copied from interface: LogicalConnection

Report that the Remote Endpoint CLOSE Frame has been received

Specified by:

remoteClose in interface LogicalConnection

Parameters:

close - the close frame details

setSession

public void setSession(WebSocketSession session)

Description copied from interface: LogicalConnection

Associate the Active Session with the connection.

Specified by:

setSession in interface LogicalConnection

Parameters:

session - the session for this connection

onIdleExpired

public boolean onIdleExpired()

Description copied from interface: Connection

Callback method invoked upon an idle timeout event.

Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.

When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.

Specified by:

onIdleExpired in interface Connection

Overrides:

onIdleExpired in class AbstractConnection

Returns:

true to let the EndPoint handle the idle timeout, false to tell the EndPoint to halt the handling of the idle timeout.

close

public void close()

Jetty Connection Close

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Overrides:

close in class AbstractConnection

disconnect

public void disconnect()

Description copied from interface: LogicalConnection

Terminate the connection (no close frame sent)

Specified by:

disconnect in interface LogicalConnection

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()

getBufferPool

public ByteBufferPool getBufferPool()

Description copied from interface: LogicalConnection

Get the ByteBufferPool in use by the connection

Specified by:

getBufferPool in interface LogicalConnection

Returns:

the buffer pool

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()

getId

public String getId()

Description copied from interface: LogicalConnection

Get Unique ID for the Connection

Specified by:

getId in interface LogicalConnection

Returns:

the unique ID for the connection

getIdleTimeout

public long getIdleTimeout()

Description copied from interface: LogicalConnection

Get the read/write idle timeout.

Specified by:

getIdleTimeout in interface LogicalConnection

Returns:

the idle timeout in milliseconds

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

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: LogicalConnection

Get the local InetSocketAddress 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:

getLocalAddress in interface LogicalConnection

Returns:

the local address.

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()

getStats

@Deprecated
public AbstractWebSocketConnection.Stats getStats()

Deprecated.

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.

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()

resume

public void resume()

Description copied from interface: SuspendToken

Resume a previously suspended connection.

Specified by:

resume in interface SuspendToken

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:

the suspend token

outgoingFrame

public void outgoingFrame(Frame frame,
                          WriteCallback callback,
                          BatchMode batchMode)

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 layer.

callback - the callback to notify when the frame is written.

batchMode - the batch mode requested by the sender.

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)

This idle timeout cannot be garunteed to take immediate effect for any active read/write actions. New read/write actions will have this new idle timeout.

Specified by:

setMaxIdleTimeout in interface LogicalConnection

Parameters:

ms - the number of milliseconds of idle timeout

dumpSelf

public String dumpSelf()

Description copied from interface: Dumpable

The description of this/self found in the dump. Allows for alternative representation of Object other then .toString() where the long form output of toString() is represented in a cleaner way within the dump infrastructure.

Specified by:

dumpSelf in interface Dumpable

Returns:

the representation of self

dump

public void dump(Appendable out,
                 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

toConnectionString

public String toConnectionString()

Overrides:

toConnectionString in class AbstractConnection

onUpgradeTo

public void onUpgradeTo(ByteBuffer prefilled)

Extra bytes from the initial HTTP upgrade that need to be processed by the websocket parser before starting to read bytes from the connection

Specified by:

onUpgradeTo in interface Connection.UpgradeTo

Parameters:

prefilled - An optional buffer that can contain prefilled data. Typically this results from an upgrade of one protocol to the other where the old connection has buffered data destined for the new connection. The new connection must take ownership of the buffer and is responsible for returning it to the buffer pool

setNextIncomingFrames

public void setNextIncomingFrames(IncomingFrames incoming)

Description copied from interface: LogicalConnection

Set where the connection should send the incoming frames to.

Often this is from the Parser to the start of the extension stack, and eventually on to the session.

Specified by:

setNextIncomingFrames in interface LogicalConnection

Parameters:

incoming - the incoming frames handler

getMessagesIn

public long getMessagesIn()

Specified by:

getMessagesIn in interface Connection

Overrides:

getMessagesIn in class AbstractConnection

Returns:

the number of WebSocket frames received over this connection

getMessagesOut

public long getMessagesOut()

Specified by:

getMessagesOut in interface Connection

Overrides:

getMessagesOut in class AbstractConnection

Returns:

the number of WebSocket frames sent over this connection

getBytesIn

public long getBytesIn()

Specified by:

getBytesIn in interface Connection

Overrides:

getBytesIn in class AbstractConnection

Returns:

the number of bytes received over this connection

getBytesOut

public long getBytesOut()

Specified by:

getBytesOut in interface Connection

Overrides:

getBytesOut in class AbstractConnection

Returns:

the number of bytes frames sent over this connection