Package org.eclipse.jetty.websocket.common.io

Class AbstractWebSocketConnection

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, org.eclipse.jetty.io.Connection, org.eclipse.jetty.io.Connection.UpgradeTo, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.websocket.api.extensions.OutgoingFrames, org.eclipse.jetty.websocket.api.SuspendToken, LogicalConnection
    public abstract class AbstractWebSocketConnection
extends org.eclipse.jetty.io.AbstractConnection
implements LogicalConnection, org.eclipse.jetty.io.Connection.UpgradeTo, org.eclipse.jetty.util.component.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

        org.eclipse.jetty.io.Connection.Listener, org.eclipse.jetty.io.Connection.UpgradeFrom, org.eclipse.jetty.io.Connection.UpgradeTo

    • Field Summary

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

        KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractWebSocketConnection​(org.eclipse.jetty.io.EndPoint endp, java.util.concurrent.Executor executor, org.eclipse.jetty.util.thread.Scheduler scheduler, org.eclipse.jetty.websocket.api.WebSocketPolicy policy, org.eclipse.jetty.io.ByteBufferPool bufferPool)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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​(java.lang.Throwable cause)
      Close the connection based on the throwable
      void close​(CloseInfo close, org.eclipse.jetty.util.Callback callback)
      Request a local close.
      void disconnect()
      Terminate the connection (no close frame sent)
      void dump​(java.lang.Appendable out, java.lang.String indent)  
      java.lang.String dumpSelf()  
      void fillInterested()  
      org.eclipse.jetty.io.ByteBufferPool getBufferPool()
      Get the ByteBufferPool in use by the connection
      long getBytesIn()  
      long getBytesOut()  
      java.util.concurrent.Executor getExecutor()
      Get the Executor used by this connection.
      java.util.List<org.eclipse.jetty.websocket.api.extensions.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.
      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()  
      org.eclipse.jetty.websocket.api.WebSocketPolicy getPolicy()
      The policy that the connection is running under.
      java.net.InetSocketAddress getRemoteAddress()
      Get the remote Address in use for this connection.
      org.eclipse.jetty.util.thread.Scheduler getScheduler()  
      AbstractWebSocketConnection.Stats getStats()  
      boolean isOpen()
      Test if logical connection is still open
      boolean isReading()
      Tests if the connection is actively reading.
      void onFillable()  
      protected void onFillInterestedFailed​(java.lang.Throwable cause)  
      boolean onIdleExpired()  
      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
      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​(org.eclipse.jetty.websocket.api.extensions.Frame frame, org.eclipse.jetty.websocket.api.WriteCallback callback, org.eclipse.jetty.websocket.api.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()  
      void setExtensions​(java.util.List<org.eclipse.jetty.websocket.api.extensions.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.
      org.eclipse.jetty.websocket.api.SuspendToken suspend()
      Suspend a the incoming read events on the connection.
      java.lang.String toConnectionString()  
      java.lang.String toStateString()
      Get the Connection State as a String

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

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

      • Methods inherited from class java.lang.Object

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

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

        dump

    • Constructor Detail

      • AbstractWebSocketConnection

        public AbstractWebSocketConnection​(org.eclipse.jetty.io.EndPoint endp,
                                   java.util.concurrent.Executor executor,
                                   org.eclipse.jetty.util.thread.Scheduler scheduler,
                                   org.eclipse.jetty.websocket.api.WebSocketPolicy policy,
                                   org.eclipse.jetty.io.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 org.eclipse.jetty.io.AbstractConnection
        Returns:
        the executor

      • close

        public void close​(java.lang.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 java.lang.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

      • onIdleExpired

        public boolean onIdleExpired()
        Specified by:
        onIdleExpired in interface org.eclipse.jetty.io.Connection
        Overrides:
        onIdleExpired in class org.eclipse.jetty.io.AbstractConnection

      • 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 org.eclipse.jetty.io.Connection
        Overrides:
        close in class org.eclipse.jetty.io.AbstractConnection

      • fillInterested

        public void fillInterested()
        Overrides:
        fillInterested in class org.eclipse.jetty.io.AbstractConnection

      • getBufferPool

        public org.eclipse.jetty.io.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<org.eclipse.jetty.websocket.api.extensions.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

      • 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 org.eclipse.jetty.websocket.api.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 org.eclipse.jetty.util.thread.Scheduler getScheduler()

      • 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()
        Specified by:
        onFillable in class org.eclipse.jetty.io.AbstractConnection

      • onFillInterestedFailed

        protected void onFillInterestedFailed​(java.lang.Throwable cause)
        Overrides:
        onFillInterestedFailed in class org.eclipse.jetty.io.AbstractConnection

      • 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

      • onReadTimeout

        protected boolean onReadTimeout​(java.lang.Throwable timeout)
        Event for no activity on connection (read or write)
        Overrides:
        onReadTimeout in class org.eclipse.jetty.io.AbstractConnection
        Returns:
        true to signal that the endpoint must be closed, false to keep the endpoint open

      • outgoingFrame

        public void outgoingFrame​(org.eclipse.jetty.websocket.api.extensions.Frame frame,
                          org.eclipse.jetty.websocket.api.WriteCallback callback,
                          org.eclipse.jetty.websocket.api.BatchMode batchMode)
        Frame from API, User, or Internal implementation destined for network.
        Specified by:
        outgoingFrame in interface org.eclipse.jetty.websocket.api.extensions.OutgoingFrames

      • resume

        public void resume()
        Specified by:
        resume in interface org.eclipse.jetty.websocket.api.SuspendToken

      • suspend

        public org.eclipse.jetty.websocket.api.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

      • setExtensions

        public void setExtensions​(java.util.List<org.eclipse.jetty.websocket.api.extensions.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 org.eclipse.jetty.io.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 java.lang.String dumpSelf()
        Specified by:
        dumpSelf in interface org.eclipse.jetty.util.component.Dumpable

      • dump

        public void dump​(java.lang.Appendable out,
                 java.lang.String indent)
          throws java.io.IOException
        Specified by:
        dump in interface org.eclipse.jetty.util.component.Dumpable
        Throws:
        java.io.IOException

      • toConnectionString

        public java.lang.String toConnectionString()
        Overrides:
        toConnectionString in class org.eclipse.jetty.io.AbstractConnection

      • 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 org.eclipse.jetty.io.Connection.UpgradeTo

      • getMessagesIn

        public long getMessagesIn()
        Specified by:
        getMessagesIn in interface org.eclipse.jetty.io.Connection
        Overrides:
        getMessagesIn in class org.eclipse.jetty.io.AbstractConnection
        Returns:
        the number of WebSocket frames received over this connection

      • getMessagesOut

        public long getMessagesOut()
        Specified by:
        getMessagesOut in interface org.eclipse.jetty.io.Connection
        Overrides:
        getMessagesOut in class org.eclipse.jetty.io.AbstractConnection
        Returns:
        the number of WebSocket frames sent over this connection

      • getBytesIn

        public long getBytesIn()
        Specified by:
        getBytesIn in interface org.eclipse.jetty.io.Connection
        Overrides:
        getBytesIn in class org.eclipse.jetty.io.AbstractConnection
        Returns:
        the number of bytes received over this connection

      • getBytesOut

        public long getBytesOut()
        Specified by:
        getBytesOut in interface org.eclipse.jetty.io.Connection
        Overrides:
        getBytesOut in class org.eclipse.jetty.io.AbstractConnection
        Returns:
        the number of bytes frames sent over this connection