WsFrameServer (Apache Tomcat 8.5.12 API Documentation)

org.apache.tomcat.websocket.server

## Class WsFrameServer

- java.lang.Object
- - org.apache.tomcat.websocket.WsFrameBase
  - - org.apache.tomcat.websocket.server.WsFrameServer

-     public class WsFrameServer
      extends WsFrameBase

- - ### Field Summary

    - ### Fields inherited from class org.apache.tomcat.websocket.WsFrameBase

      `inputBuffer, wsSession`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `WsFrameServer(SocketWrapperBase<?> socketWrapper, WsSession wsSession, Transformation transformation, ClassLoader applicationClassLoader)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected Log` | `getLog()`
    `protected Transformation` | `getTransformation()`
    `protected boolean` | `isMasked()`
    `protected boolean` | `isOpen()`
    `void` | `onDataAvailable()` Called when there is data in the ServletInputStream to process.
    `protected void` | `sendMessageBinary(ByteBuffer msg, boolean last)`
    `protected void` | `sendMessageText(boolean last)`

    - ### Methods inherited from class org.apache.tomcat.websocket.WsFrameBase

      `byteArrayToLong, processInputBuffer`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### WsFrameServer

          public WsFrameServer(SocketWrapperBase<?> socketWrapper,
                       WsSession wsSession,
                       Transformation transformation,
                       ClassLoader applicationClassLoader)

  - ### Method Detail

    - #### onDataAvailable

          public void onDataAvailable()
                               throws IOException

      Called when there is data in the ServletInputStream to process.
      Throws:
        `IOException` - if an I/O error occurs while processing the available data

    - #### isMasked

          protected boolean isMasked()

      Specified by:
        `isMasked` in class `WsFrameBase`

    - #### getTransformation

          protected Transformation getTransformation()

      Overrides:
        `getTransformation` in class `WsFrameBase`

    - #### isOpen

          protected boolean isOpen()

      Overrides:
        `isOpen` in class `WsFrameBase`

    - #### getLog

          protected Log getLog()

      Specified by:
        `getLog` in class `WsFrameBase`

    - #### sendMessageText

          protected void sendMessageText(boolean last)
                                  throws WsIOException

      Overrides:
        `sendMessageText` in class `WsFrameBase`
      Throws:
        `WsIOException`

    - #### sendMessageBinary

          protected void sendMessageBinary(ByteBuffer msg,
                               boolean last)
                                    throws WsIOException

      Overrides:
        `sendMessageBinary` in class `WsFrameBase`
      Throws:
        `WsIOException`

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.