AbstractWebSocketConnection (Jetty :: Project 9.4.11.v20180605 API)

java.lang.Object
- org.eclipse.jetty.io.AbstractConnection
- - org.eclipse.jetty.websocket.common.io.AbstractWebSocketConnection

All Implemented Interfaces:

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

Direct Known Subclasses:

WebSocketClientConnection, WebSocketServerConnection
```
public abstract class AbstractWebSocketConnection
extends AbstractConnection
implements LogicalConnection, Connection.UpgradeTo, IOState.ConnectionStateListener, 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 Description

static class AbstractWebSocketConnection.Stats
- Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection
  Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractWebSocketConnection.Stats`

Constructor Summary

Constructors
Constructor	Description
`AbstractWebSocketConnection(EndPoint endp, java.util.concurrent.Executor executor, Scheduler scheduler, WebSocketPolicy policy, ByteBufferPool bufferPool)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Jetty Connection Close
`void`	`disconnect()`	Terminate the connection (no close frame sent)
`java.lang.String`	`dump()`
`void`	`dump(java.lang.Appendable out, java.lang.String indent)`
`boolean`	`equals(java.lang.Object obj)`
`void`	`fillInterested()`	Utility method to be called to register read interest.
`ByteBufferPool`	`getBufferPool()`	Get the ByteBufferPool in use by the connection
`java.util.concurrent.Executor`	`getExecutor()`	Get the Executor used by this connection.
`java.util.List<ExtensionConfig>`	`getExtensions()`	Get the list of extensions in use.
`Generator`	`getGenerator()`
`java.lang.String`	`getId()`	Get Unique ID for the Connection
`long`	`getIdleTimeout()`	Get the read/write idle timeout.
`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.
`java.net.InetSocketAddress`	`getRemoteAddress()`	Get the remote Address in use for this connection.
`Scheduler`	`getScheduler()`
`AbstractWebSocketConnection.Stats`	`getStats()`
`int`	`hashCode()`
`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(java.lang.Throwable cause)`	Callback method invoked when the endpoint failed to be ready to be read.
`boolean`	`onIdleExpired()`	Callback method invoked upon an idle timeout event.
`void`	`onLocalClose(CloseInfo close)`	Called to indicate a close frame was successfully sent to the remote.
`void`	`onOpen()`	Callback method invoked when this connection is opened.
`protected boolean`	`onReadTimeout(java.lang.Throwable timeout)`	Event for no activity on connection (read or write)
`void`	`onUpgradeTo(java.nio.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
`void`	`outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)`	Frame from API, User, or Internal implementation destined for network.
`void`	`resume()`	Resume a previously suspended connection.
`void`	`setExtensions(java.util.List<ExtensionConfig> extensions)`	Get the list of extensions in use.
`protected void`	`setInitialBuffer(java.nio.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
`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)`	Associate the Active Session with the connection.
`SuspendToken`	`suspend()`	Suspend a the incoming read events on the connection.
`java.lang.String`	`toConnectionString()`

Methods inherited from class org.eclipse.jetty.io.AbstractConnection
addListener, failedCallback, getBytesIn, getBytesOut, getCreatedTimeStamp, getEndPoint, getInputBufferSize, getMessagesIn, getMessagesOut, isFillInterested, removeListener, toString, tryFillInterested, tryFillInterested

Methods inherited from interface org.eclipse.jetty.websocket.common.LogicalConnection
getLocalAddress, setNextIncomingFrames

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractWebSocketConnection
```
public AbstractWebSocketConnection(EndPoint endp,
                                   java.util.concurrent.Executor executor,
                                   Scheduler scheduler,
                                   WebSocketPolicy policy,
                                   ByteBufferPool bufferPool)
```
- Method Detail
  - getExecutor
```
public java.util.concurrent.Executor getExecutor()
```
    Description copied from interface: LogicalConnection
    
    Get the Executor used by this connection.
    
    Specified by:
    
    getExecutor in interface LogicalConnection
    
    Overrides:
    
    getExecutor in class AbstractConnection
    
    Returns:
    
    the executor
  - onLocalClose
```
public void onLocalClose(CloseInfo close)
```
    Description copied from interface: LogicalConnection
    
    Called to indicate a close frame was successfully sent to the remote.
    
    Specified by:
    
    onLocalClose in interface LogicalConnection
    
    Parameters:
    
    close - the close 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 java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    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 java.util.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 java.lang.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
  - 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 java.net.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
```
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(java.lang.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
  - setInitialBuffer
```
protected void setInitialBuffer(java.nio.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
    
    Parameters:
    
    prefilled - the bytes of prefilled content encountered during upgrade
  - 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(java.lang.Throwable timeout)
```
    Event for no activity on connection (read or write)
    
    Overrides:
    
    onReadTimeout in class AbstractConnection
    
    Parameters:
    
    timeout - the cause of the read timeout
    
    Returns:
    
    true to signal that the endpoint must be closed, false to keep the endpoint open
  - 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.
  - resume
```
public void resume()
```
    Description copied from interface: SuspendToken
    
    Resume a previously suspended connection.
    
    Specified by:
    
    resume in interface SuspendToken
  - setExtensions
```
public void setExtensions(java.util.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
  - 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
  - dump
```
public java.lang.String dump()
```
    Specified by:
    
    dump in interface Dumpable
  - dump
```
public void dump(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException
```
    Specified by:
    
    dump in interface Dumpable
    
    Throws:
    
    java.io.IOException
  - toConnectionString
```
public java.lang.String toConnectionString()
```
    Overrides:
    
    toConnectionString in class AbstractConnection
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - onUpgradeTo
```
public void onUpgradeTo(java.nio.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

Class AbstractWebSocketConnection

Nested Class Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

AbstractWebSocketConnection

Method Detail

getExecutor

onLocalClose

setSession

onIdleExpired

close

disconnect

fillInterested

getBufferPool

getExtensions

getGenerator

getId

getIdleTimeout

getIOState

getMaxIdleTimeout

getParser

getPolicy

getRemoteAddress

getScheduler

getStats

isOpen

isReading

onClose

onConnectionStateChange

onFillable

onFillInterestedFailed

setInitialBuffer

onOpen

onReadTimeout

outgoingFrame

resume

setExtensions

setInputBufferSize

setMaxIdleTimeout

suspend

dump

dump

toConnectionString

hashCode

equals

onUpgradeTo