WebSockex v0.4.3

WebSockex.Frame (WebSockex v0.4.3) View Source

Functions for parsing and encoding frames.

Link to this section Summary

Types

buffer()

The incomplete or unhandled remainder of a binary

close_code()
frame()
opcode()
utf8()

This is required to be valid UTF-8

Functions

encode_frame(frame)

Encodes a frame into a binary for sending.

parse_fragment(fragmented_parts, continuation_frame)

Parses and combines two frames in a fragmented segment.

parse_frame(data)

Parses a bitstring and returns a frame.

Link to this section Types

Link to this type

buffer()

View Source

Specs

buffer() :: bitstring()

The incomplete or unhandled remainder of a binary

Link to this type

close_code()

View Source

Specs

close_code() :: 1000..4999
Link to this type

frame()

View Source

Specs

frame() ::
  :ping
  | :pong
  | :close
  | {:ping, binary()}
  | {:pong, binary()}
  | {:close, close_code(), utf8()}
  | {:text, utf8()}
  | {:binary, binary()}
  | {:fragment, :text | :binary, binary()}
  | {:continuation, binary()}
  | {:finish, binary()}
Link to this type

opcode()

View Source

Specs

opcode() :: :text | :binary | :close | :ping | :pong
Link to this type

utf8()

View Source

Specs

utf8() :: binary()

This is required to be valid UTF-8

Link to this section Functions

Link to this function

encode_frame(frame)

View Source

Specs

encode_frame(frame()) ::
  {:ok, binary()}
  | {:error,
     %WebSockex.FrameEncodeError{
       __exception__: term(),
       close_code: term(),
       frame_payload: term(),
       frame_type: term(),
       reason: term()
     }}

Encodes a frame into a binary for sending.

Link to this function

parse_fragment(fragmented_parts, continuation_frame)

View Source

Specs

parse_fragment(
  {:fragment, :text | :binary, binary()},
  {:continuation | :finish, binary()}
) ::
  {:fragment, :text | :binary, binary()}
  | {:text | :binary, binary()}
  | {:error,
     %WebSockex.FragmentParseError{
       __exception__: term(),
       continuation: term(),
       fragment: term(),
       reason: term()
     }}

Parses and combines two frames in a fragmented segment.

Link to this function

parse_frame(data)

View Source

Specs

parse_frame(bitstring()) ::
  :incomplete
  | {:ok, frame(), buffer()}
  | {:error,
     %WebSockex.FrameError{
       __exception__: term(),
       buffer: term(),
       opcode: term(),
       reason: term()
     }}

Parses a bitstring and returns a frame.