Module roadrunner_http2_frame

Data Types

error_code()

error_code() = no_error | protocol_error | internal_error | flow_control_error | settings_timeout | stream_closed | frame_size_error | refused_stream | cancel | compression_error | connect_error | enhance_your_calm | inadequate_security | http_1_1_required | non_neg_integer()

flags()

flags() = 0..255

frame()

frame() = {data, stream_id(), flags(), Payload::iodata()} | {data, stream_id(), flags(), Body::binary(), FlowLen::non_neg_integer()} | {headers, stream_id(), flags(), Priority::priority() | undefined, HeaderBlock::iodata()} | {priority, stream_id(), priority()} | {rst_stream, stream_id(), error_code()} | {settings, flags(), [settings_param()]} | {push_promise, stream_id(), flags(), PromisedStreamId::stream_id(), HeaderBlock::iodata()} | {ping, flags(), OpaqueData::<<_:64>>} | {goaway, LastStreamId::stream_id(), error_code(), DebugData::iodata()} | {window_update, stream_id(), Increment::1..2147483647} | {continuation, stream_id(), flags(), HeaderBlock::iodata()} | {unknown, Type::non_neg_integer(), stream_id()}

frame_type()

frame_type() = data | headers | priority | rst_stream | settings | push_promise | ping | goaway | window_update | continuation

parse_error()

parse_error() = frame_size_error | protocol_error | stream_id_violation | bad_padding | bad_priority_payload | bad_rst_stream_payload | bad_settings_payload | bad_push_promise_payload | bad_ping_payload | bad_goaway_payload | bad_window_update_payload | window_update_zero_increment

parse_result()

parse_result() = {ok, frame(), Rest::binary()} | {more, Need::pos_integer()} | {error, parse_error()}

priority()

priority() = #{exclusive := boolean(), stream_dependency := stream_id(), weight := 0..255}

settings_param()

settings_param() = {ParamId::non_neg_integer(), Value::non_neg_integer()}

stream_id()

stream_id() = non_neg_integer()

Function Index

encode/1
parse/2

Function Details

encode/1

encode(X1::frame()) -> iodata()

parse/2

parse(Bin::binary(), MaxFrameSize::pos_integer()) -> parse_result()


Generated by EDoc