Class JettyWebSocketFrame

java.lang.Object
org.eclipse.jetty.websocket.common.JettyWebSocketFrame
All Implemented Interfaces:
Frame
public class JettyWebSocketFrame extends Object implements Frame

  • Constructor Details

    • JettyWebSocketFrame

      @Deprecated(forRemoval=true, since="12.1.0") public JettyWebSocketFrame(Frame frame)
      Deprecated, for removal: This API element is subject to removal in a future version.
      there is no alternative intended to publicly construct a JettyWebSocketFrame.
      Parameters:
      frame - the core websocket Frame to wrap as a Frame.

  • Method Details

    • getMask

      public byte[] getMask()
      Specified by:
      getMask in interface Frame

    • getOpCode

      public byte getOpCode()
      Specified by:
      getOpCode in interface Frame

    • getPayload

      public ByteBuffer getPayload()
      Specified by:
      getPayload in interface Frame

    • getPayloadLength

      public int getPayloadLength()
      Description copied from interface: Frame
      The original payload length (Buffer.remaining())
      Specified by:
      getPayloadLength in interface Frame
      Returns:
      the original payload length (Buffer.remaining())

    • getType

      public Frame.Type getType()
      Specified by:
      getType in interface Frame

    • hasPayload

      public boolean hasPayload()
      Specified by:
      hasPayload in interface Frame

    • isFin

      public boolean isFin()
      Specified by:
      isFin in interface Frame

    • isMasked

      public boolean isMasked()
      Specified by:
      isMasked in interface Frame

    • isRsv1

      public boolean isRsv1()
      Specified by:
      isRsv1 in interface Frame

    • isRsv2

      public boolean isRsv2()
      Specified by:
      isRsv2 in interface Frame

    • isRsv3

      public boolean isRsv3()
      Specified by:
      isRsv3 in interface Frame

    • getEffectiveOpCode

      public byte getEffectiveOpCode()
      Description copied from interface: Frame
      The effective opcode of the frame accounting for the CONTINUATION opcode. If the frame is a CONTINUATION frame for a TEXT message, this will return TEXT. If the frame is a CONTINUATION frame for a BINARY message, this will return BINARY. Otherwise, this will return the same opcode as the frame.
      Specified by:
      getEffectiveOpCode in interface Frame
      Returns:
      the effective opcode of the frame.

    • getCloseStatus

      public Frame.CloseStatus getCloseStatus()
      Specified by:
      getCloseStatus in interface Frame

    • toString

      public String toString()
      Overrides:
      toString in class Object