ankh v0.8.10 Ankh.HTTP2.Frame
HTTP/2 frame struct
The using macro injects the frame struct needed by Ankh.HTTP2.Frame
.
Link to this section Summary
Types
Frame data
Frame length
Encode/Decode options
Struct injected by the Ankh.HTTP2.Frame
using macro.
Frame type code
Functions
Injects the frame struct in a module.
Decodes a binary into a frame struct
Encodes a frame struct into binary
Returns s tream of frames from a buffer, returning the leftover buffer data and the frame header information and data (without decoding it) in a tuple
Link to this section Types
data()
Specs
data() :: iodata()
Frame data
length()
Specs
length() :: non_neg_integer()
Frame length
options()
Specs
options() :: Keyword.t()
Encode/Decode options
Specs
t() :: struct()
Struct injected by the Ankh.HTTP2.Frame
using macro.
type()
Specs
type() :: non_neg_integer()
Frame type code
Link to this section Functions
Specs
Injects the frame struct in a module.
- type: HTTP/2 frame type code
- flags: data type implementing
Ankh.HTTP2.Frame.Encodable
- payload: data type implementing
Ankh.HTTP2.Frame.Encodable
decode(frame, data, options \\ [])
Specs
Decodes a binary into a frame struct
Parameters:
- struct: struct using
Ankh.HTTP2.Frame
- binary: data to decode into the struct
- options: options to pass as context to the decoding function
encode(frame, options \\ [])
Specs
Encodes a frame struct into binary
Parameters:
- struct: struct using
Ankh.HTTP2.Frame
- options: options to pass as context to the encoding function
stream(data)
Specs
stream(iodata()) :: Enumerable.t()
Returns s tream of frames from a buffer, returning the leftover buffer data and the frame header information and data (without decoding it) in a tuple:
{remaining_buffer, {length, type, id, frame_data}}
or nil to signal partial leftover data:
{remaining_buffer, nil}