WsFrameClient (Apache Tomcat 8.5.57 API Documentation)

org.apache.tomcat.websocket

## Class WsFrameClient

- java.lang.Object
- - org.apache.tomcat.websocket.WsFrameBase
  - - org.apache.tomcat.websocket.WsFrameClient

-     public class WsFrameClient
      extends WsFrameBase

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.tomcat.websocket.WsFrameBase

      `WsFrameBase.ReadState`

  - ### Field Summary

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

      `inputBuffer, wsSession`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `WsFrameClient(ByteBuffer response, AsyncChannelWrapper channel, WsSession wsSession, Transformation transformation)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected Log` | `getLog()`
    `protected boolean` | `isMasked()`
    `protected void` | `resumeProcessing()` This method will be invoked when the read operation is resumed.

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

      `byteArrayToLong, changeReadState, changeReadState, getReadState, getTransformation, isOpen, isSuspended, processInputBuffer, resume, sendMessageBinary, sendMessageText, suspend`

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

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

- - ### Constructor Detail

    - #### WsFrameClient

          public WsFrameClient(ByteBuffer response,
                       AsyncChannelWrapper channel,
                       WsSession wsSession,
                       Transformation transformation)

  - ### Method Detail

    - #### isMasked

          protected boolean isMasked()

      Specified by:
        `isMasked` in class `WsFrameBase`

    - #### getLog

          protected Log getLog()

      Specified by:
        `getLog` in class `WsFrameBase`

    - #### resumeProcessing

          protected void resumeProcessing()

      Description copied from class: `WsFrameBase`
      This method will be invoked when the read operation is resumed. As the suspend of the read operation can be invoked at any time, when implementing this method one should consider that there might still be data remaining into the internal buffers that needs to be processed before reading again from the socket.
      Specified by:
        `resumeProcessing` in class `WsFrameBase`

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