Method Detail

• compose

  public static ExtensionFunction compose(List<ExtensionFunction> functions)

• compose

  public static ExtensionFunction compose(ExtensionFunction... functions)

• hasExtensionOpCode

  public boolean hasExtensionOpCode()

  Description copied from interface: ExtensionFunction
  Validate if current extension defines a new WebSocket Opcode.

  Specified by:

  hasExtensionOpCode in interface ExtensionFunction

  Returns:

  true if current extension defines specific Opcode false is current extension does not define specific Opcode

  See Also:

  WebSocket Base Framing Protocol Reference

• writeRsv

  public int writeRsv(int rsv)

  Description copied from interface: ExtensionFunction
  Add RSV bits (RSV1, RSV2, RSV3) to the current rsv status.

  Specified by:

  writeRsv in interface ExtensionFunction

  Parameters:

  rsv - current RSV bits status

  Returns:

  rsv status

• transformForWrite

  public PooledByteBuffer transformForWrite(PooledByteBuffer pooledBuffer,
                                            StreamSinkFrameChannel channel,
                                            boolean lastFrame)
                                     throws IOException

  Description copied from interface: ExtensionFunction
  Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer

  Specified by:

  transformForWrite in interface ExtensionFunction

  Parameters:

  pooledBuffer - Buffer to transform

  channel - working channel

  Returns:

  transformed buffer (may be the same one, just with modified contents)

  Throws:

  IOException

• transformForRead

  public PooledByteBuffer transformForRead(PooledByteBuffer pooledBuffer,
                                           StreamSourceFrameChannel channel,
                                           boolean lastFragementOfMessage)
                                    throws IOException

  Description copied from interface: ExtensionFunction
  Transform the supplied buffer per this extension. The buffer can be modified in place, or a new pooled buffer can be returned (in which case be sure to free the original buffer

  Specified by:

  transformForRead in interface ExtensionFunction

  Parameters:

  pooledBuffer - Buffer to transform

  channel - working channel

  lastFragementOfMessage - If this frame is the last fragment of a message. Note that this may not be received for every message, if the message ends with an empty frame

  Returns:

  transformed buffer (may be the same one, just with modified contents)

  Throws:

  IOException

• dispose

  public void dispose()

  Description copied from interface: ExtensionFunction
  Dispose this function. Called upon connection closure

  Specified by:

  dispose in interface ExtensionFunction