Module ntex::ws

WebSocket protocol support.

To setup a WebSocket, first do web socket handshake then on success convert Payload into a WsStream stream and then use WsWriter to communicate with the peer.

Modules

• error
  WebSocket protocol related errors.

Structs

• CloseReason
  Reason for closing the connection
• Codec
  WebSockets protocol codec
• Parser
  WebSocket frame parser.
• WsClient
  WebSocket client builder
• WsClientBuilder
  WebSocket client builder
• WsConnection
• WsSink
• WsTransport
  An implementation of WebSockets streams
• WsTransportService
  WebSockets transport service

Enums

• CloseCode
  Status code used to indicate why an endpoint is closing the WebSocket connection.
• Frame
  WebSocket frame
• Item
  WebSocket continuation item
• Message
  WebSocket message
• OpCode
  Operation codes as part of rfc6455.

Functions

• handshake
  Verify WebSocket handshake request and create handshake reponse.
• handshake_response
  Create websocket’s handshake response
• hash_key
• verify_handshake
  Verify WebSocket handshake request.