org.eclipse.jetty.websocket.server

Class WebSocketServerConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

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

org.eclipse.jetty.websocket.server.WebSocketServerConnection

All Implemented Interfaces:

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

public class WebSocketServerConnection
extends AbstractWebSocketConnection
implements Connection.UpgradeTo

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.websocket.common.io.AbstractWebSocketConnection

AbstractWebSocketConnection.OnCloseLocalCallback, AbstractWebSocketConnection.OnDisconnectCallback, AbstractWebSocketConnection.Stats

Nested classes/interfaces inherited from class org.eclipse.jetty.io.AbstractConnection

AbstractConnection.FillingInterestedCallback, AbstractConnection.NestedState, AbstractConnection.State

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

Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

Field Summary

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

EXECUTE_ONFILLABLE, FILL_INTERESTED, FILLING, FILLING_FILL_INTERESTED, IDLE, REFILLING

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
InetSocketAddress	getLocalAddress() Get the local InetSocketAddress in use for this connection.
InetSocketAddress	getRemoteAddress() Get the remote Address in use for this connection.
void	onOpen()
void	onUpgradeTo(ByteBuffer prefilled) Callback method invoked when this Connection is upgraded.
void	setNextIncomingFrames(IncomingFrames incoming) Set where the connection should send the incoming frames to.

Methods inherited from class org.eclipse.jetty.websocket.common.io.AbstractWebSocketConnection

close, close, disconnect, dump, dump, execute, fillInterested, getBufferPool, getExecutor, getExtensions, getGenerator, getIdleTimeout, getIOState, getMaxIdleTimeout, getParser, getPolicy, getScheduler, getSession, getStats, isOpen, isReading, onClose, onConnectionStateChange, onFillable, onFillInterestedFailed, onReadTimeout, outgoingFrame, prefill, resume, setExtensions, setInputBufferSize, setMaxIdleTimeout, setSession, suspend, toString

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

addListener, failedCallback, fillInterested, getBytesIn, getBytesOut, getCreatedTimeStamp, getEndPoint, getInputBufferSize, getMessagesIn, getMessagesOut, next

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.io.Connection

addListener, close, getBytesIn, getBytesOut, getCreatedTimeStamp, getEndPoint, getMessagesIn, getMessagesOut, onClose

Constructor Detail

WebSocketServerConnection

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

Method Detail

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

Overrides:

getRemoteAddress in class AbstractWebSocketConnection

Returns:

the remote address.

onUpgradeTo

public void onUpgradeTo(ByteBuffer prefilled)

Description copied from interface: Connection.UpgradeTo

Callback method invoked when this Connection is upgraded.

This must be called before Connection.onOpen().

Specified by:

onUpgradeTo in interface Connection.UpgradeTo

onOpen

public void onOpen()

Specified by:

onOpen in interface Connection

Overrides:

onOpen in class AbstractWebSocketConnection

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