abstract struct Amber::WebSockets::ClientSocket

• Amber::WebSockets::ClientSocket
• Struct
• Value
• Object

Overview

ClientSocket struct maps a user to an HTTP::WebSocket. For every websocket connection there will be an associated ClientSocket. Authentication and authorization happen within the ClientSocket. ClientSocket will subscribe to Channels, where incoming and outgoing messages are routed through.

Example:

struct UserSocket < Amber::WebSockets::ClientSocket
  channel "user_channel:*", UserChannel
  channel "room_channel:*", RoomChannel

  # Optional: override the default decoder
  def self.decoder
    Amber::WebSockets::Decoders::TextDecoder.new
  end

  def on_connect
    return some_auth_method!
  end
end

Direct Known Subclasses

• Amber::Testing::TestClientSocket

Defined in:

Constant Summary

BEAT_INTERVAL = 30.seconds

DEFAULT_MESSAGE_BUFFER_SIZE = 100

Default maximum number of messages to buffer during a disconnection.

Log = ::Log.for(self)

MAX_SOCKET_IDLE_TIME = 100.seconds

RECONNECT_WINDOW = 60.seconds

Default reconnection window: how long a disconnected socket can reconnect and recover buffered messages.

Constructors

• .new(socket : HTTP::WebSocket, context : HTTP::Server::Context, connection_id : String)

  Initialize with an existing connection_id for reconnection.

• .new(socket : HTTP::WebSocket, context : HTTP::Server::Context)

Class Method Summary

• .broadcast(event : String, topic : String, subject : String, payload : Hash)

  Broadcast a message to all subscribers of the topic

• .channel(channel_path, channel_class)

  Add a channel class for this socket type to register

• .channels
• .decoder : Decoders::Decoder

  Returns the decoder instance for this socket type.

• .get_topic_channel(topic_path)

Instance Method Summary

• #channels : Hash(String, Amber::WebSockets::Channel)

  Each socket instance has its own channels (instances created from registered classes)

• #channels=(channels : Hash(String, Amber::WebSockets::Channel))

  Each socket instance has its own channels (instances created from registered classes)

• #connection_id : String

  A stable identifier that persists across reconnections.

• #get_channel(path : String) : Channel | Nil

  Helper method to get a channel instance for this socket

• #handle_error(ex : Exception, context : String = "unknown")

  Override to implement custom error handling logic.

• #on_connect : Bool

  Authentication and authorization can happen here

• #on_disconnect

  On socket disconnect functionality

• #on_error(ex : Exception)

  Called when an error occurs at the socket level (outside of a channel).

• #on_reconnect

  Called when a previously disconnected socket reconnects within the reconnection window.

• #socket : HTTP::WebSocket

Constructor Detail

Class Method Detail

UserSocket.broadcast("message", "chats_room:1", "msg:new", {"message" => "test"})

struct BinarySocket < Amber::WebSockets::ClientSocket
  def self.decoder
    Amber::WebSockets::Decoders::BinaryDecoder.new
  end
end

Instance Method Detail