org.eclipse.jetty.websocket.client.io

Class WebSocketClientConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

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

org.eclipse.jetty.websocket.client.io.WebSocketClientConnection

All Implemented Interfaces:

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

public class WebSocketClientConnection
extends AbstractWebSocketConnection

Client side WebSocket physical connection.

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

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
WebSocketClientConnection(EndPoint endp, Executor executor, ConnectPromise connectPromise, WebSocketPolicy policy)

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	onClose() Physical connection disconnect.
void	onOpen() Callback method invoked when this Connection is opened.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode) Override to set the masker.
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, onConnectionStateChange, onFillable, onFillInterestedFailed, onReadTimeout, 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

Constructor Detail

WebSocketClientConnection

public WebSocketClientConnection(EndPoint endp,
                         Executor executor,
                         ConnectPromise connectPromise,
                         WebSocketPolicy policy)

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.

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.

onClose

public void onClose()

Description copied from class: AbstractWebSocketConnection

Physical connection disconnect.

Not related to WebSocket close handshake.

Specified by:

onClose in interface Connection

Overrides:

onClose in class AbstractWebSocketConnection

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 AbstractWebSocketConnection

outgoingFrame

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

Override to set the masker.

Specified by:

outgoingFrame in interface OutgoingFrames

Overrides:

outgoingFrame in class AbstractWebSocketConnection

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.

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.

Parameters:

incoming - the incoming frames handler