class Amber::WebSockets::Decoders::BinaryDecoder

• Amber::WebSockets::Decoders::BinaryDecoder
• Amber::WebSockets::Decoders::Decoder
• Reference
• Object

Overview

Binary decoder for WebSocket messages using a simple length-prefixed format.

This decoder provides a compact binary serialization format for WebSocket messages. Each field is encoded as a length-prefixed UTF-8 string:

[key_length:4 bytes][key_data][value_length:4 bytes][value_data]...

The field count is stored as the first 4 bytes. This format is suitable when bandwidth efficiency is important and both client and server support binary WebSocket frames.

Since Crystal WebSocket messages arrive as strings, the binary data is Base64-encoded for transport. If you receive raw binary frames, decode them from Base64 first.

Example:

decoder = Amber::WebSockets::Decoders::BinaryDecoder.new
encoded = decoder.encode({"event" => "message", "topic" => "room:1"})
decoded = decoder.decode(encoded)
decoded["event"].as_s # => "message"

Defined in:

Instance Method Summary

• #content_type : String

  Returns the MIME content type associated with this decoder.

• #decode(raw : String) : JSON::Any

  Decodes a raw message string into a structured JSON::Any value.

• #encode(payload : Hash) : String

  Encodes a Hash payload into a string suitable for sending over the socket.

• #encode(payload : JSON::Any) : String

  Encodes a JSON::Any payload into a string suitable for sending over the socket.

Instance Method Detail