org.eclipse.jetty.websocket.client.io

Class UpgradeConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

org.eclipse.jetty.websocket.client.io.UpgradeConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Connection, Connection.UpgradeFrom

public class UpgradeConnection
extends AbstractConnection
implements Connection.UpgradeFrom

This is the initial connection handling that exists immediately after physical connection is established to destination server.

Eventually, upon successful Upgrade request/response, this connection swaps itself out for the WebSocektClientConnection handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UpgradeConnection.SendUpgradeRequest

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

Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

Constructor Summary

Constructors

Constructor and Description
UpgradeConnection(EndPoint endp, Executor executor, ConnectPromise connectPromise)

Method Summary

Modifier and Type	Method and Description
void	disconnect(boolean onlyOutput)
void	onClose() Callback method invoked when this Connection is closed.
void	onFillable() Callback method invoked when the endpoint is ready to be read.
void	onOpen()
protected boolean	onReadTimeout() Callback method invoked when the endpoint failed to be ready to be read after a timeout
ByteBuffer	onUpgradeFrom() Take the input buffer from the connection on upgrade.

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

addListener, close, failedCallback, fillInterested, getBytesIn, getBytesOut, getCreatedTimeStamp, getEndPoint, getExecutor, getInputBufferSize, getMessagesIn, getMessagesOut, isDispatchIO, isFillInterested, onFillInterestedFailed, setInputBufferSize, toString

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

Constructor Detail

UpgradeConnection

public UpgradeConnection(EndPoint endp,
                         Executor executor,
                         ConnectPromise connectPromise)

Method Detail

disconnect

public void disconnect(boolean onlyOutput)

onUpgradeFrom

public ByteBuffer onUpgradeFrom()

Description copied from interface: Connection.UpgradeFrom

Take the input buffer from the connection on upgrade.

This method is used to take any unconsumed input from a connection during an upgrade.

Specified by:

onUpgradeFrom in interface Connection.UpgradeFrom

Returns:

A buffer of unconsumed input. The caller must return the buffer to the bufferpool when consumed and this connection must not.

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

onOpen

public void onOpen()

Specified by:

onOpen in interface Connection

Overrides:

onOpen in class AbstractConnection

onClose

public void onClose()

Description copied from interface: Connection

Callback method invoked when this Connection is closed.

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

Specified by:

onClose in interface Connection

Overrides:

onClose 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