Overview

• module Protocol
  • module WebSocket
    • class BinaryFrame < Frame

      Represents a binary frame that is sent or received by a WebSocket connection.
    • class CloseFrame < Frame

      Represents a close frame that is sent or received by a WebSocket connection.
    • module Coder
      • module JSON

        A JSON coder that uses the standard JSON library.
    • class Connection

      Wraps a framer and implements for implementing connection specific interactions like reading and writing text.
    • class ContinuationFrame < Frame

      Represents a continuation frame that is sent or received by a WebSocket connection when a message is split into multiple frames.
    • class Error < HTTP::Error

      Represents an error that occurred during the WebSocket protocol negotiation or communication.
    • class ProtocolError < Error

      Raised by stream or connection handlers, results in GOAWAY frame which signals termination of the current connection. You cannot recover from this exception, or any exceptions subclassed from it.
    • class ClosedError < ProtocolError

      The connection was closed, maybe unexpectedly.
    • class FrameSizeError < ProtocolError

      When the frame payload does not match expectations.
    • module Extension
      • module Compression

        Provides support for the permessage-deflate extension.

        • class Deflate

          Compresses outgoing WebSocket frames using the DEFLATE algorithm.
        • class Inflate

          Decompresses incoming WebSocket frames using the DEFLATE algorithm.
    • module Extensions

      Manages WebSocket extensions negotiated during the handshake.

      • class Client

        Manages extensions on the client side, offering and accepting server responses.
      • class Server

        Manages extensions on the server side, negotiating client offers and applying the agreed extensions.
    • class Frame

      Represents a single WebSocket frame as defined by RFC 6455.
    • class Framer

      Wraps an underlying Async::IO::Stream for reading and writing binary data into structured frames.
    • module Headers
      • module Nounce

        Provides utilities for generating and verifying the WebSocket handshake nonce.
    • class Message

      Represents a message that can be sent or received over a WebSocket connection.
    • class TextMessage < Message

      Represents a text message that can be sent or received over a WebSocket connection.
    • class BinaryMessage < Message

      Represents a binary message that can be sent or received over a WebSocket connection.
    • class PingMessage < Message

      Represents a ping message that can be sent over a WebSocket connection.
    • class PingFrame < Frame

      Represents a ping frame that is sent or received by a WebSocket connection.
    • class PongFrame < Frame

      Represents a pong frame that is sent or received by a WebSocket connection.
    • class TextFrame < Frame

      Represents a text frame that is sent or received by a WebSocket connection.