WS

Description

Commands and events for websockets

Command List

  • WS::collect - Collects the Websocket frame payload
  • WS::disconnect - The Websocket connection is disconnected by sending a close frame to both end-points when the current frame is done
  • WS::enabled - used to determine whether the Websocket processing is enabled or disabled for a particular connection
  • WS::frame - various websocket frame tasks
  • WS::masking - masking options for websocket payload
  • WS::message - Drop an entire Websocket message.
  • WS::payload - websocket payload manipulation
  • WS::release - Releases the data collected via WS::collect
  • WS::request - websocket request header access
  • WS::response - websocket response header access

Associated Events

  • WS_CLIENT_DATA - raised when the system collects the specified amount of data via the WS::collect command
  • WS_CLIENT_FRAME - raised to indicate the start of a Websocket frame received from the client
  • WS_CLIENT_FRAME_DONE - aised to indicate the end of a Websocket frame received from the client
  • WS_REQUEST - raised when certain headers are present in the client request
  • WS_RESPONSE - raised when certain headers are present in the server response
  • WS_SERVER_DATA - raised when the system collects the specified amount of data via the WS::collect command
  • WS_SERVER_FRAME - raised to indicate the start of a Websocket frame received from the server.
  • WS_SERVER_FRAME_DONE - raised to indicate the end of a Websocket frame received from the server