Sockets

A client socket represents one WebSocket connection and maps topic patterns to channel classes. Amber CLI V2 generates channels, while the socket boundary is currently hand-authored.

Run from: the application root.

amber generate channel ChatRoom --topics=chat_room

File: src/sockets/chat_socket.cr — create this socket struct, then ensure the application requires src/sockets/** before routes compile.

struct ChatSocket < Amber::WebSockets::ClientSocket
  channel "chat_room:*", ChatRoomChannel

  def on_connect : Bool
    # `session`, `cookies`, and validated `params` are available here.
    !!session[:current_user_id]?
  end
end

File: config/routes.cr — add the handshake route inside the existing routes :web block.

Amber::Server.configure do
  routes :web do
    websocket "/chat", ChatSocket
  end
end

Return false from on_connect to reject the connection. Override on_disconnect, on_reconnect, or on_error when the application needs connection lifecycle behavior.

File: the controller or service that owns the event, under src/controllers/ or src/services/ — broadcast after the application operation succeeds.

ChatSocket.broadcast(
  "message",
  "chat_room:123",
  "message_new",
  {"message" => "A new visitor!"}
)

The V1 amber g socket shortcut is not a command in the standalone V2 CLI. Create the socket struct explicitly, generate channels with amber generate channel, and cover the handshake and authorization behavior with specs.