Module cow_http2

opts() = #{enable_connect_protocol => boolean(), initial_connection_window_size => 65535..2147483647, initial_stream_window_size => 0..2147483647, max_concurrent_streams => non_neg_integer() | infinity, max_decode_table_size => non_neg_integer(), max_encode_table_size => non_neg_integer(), max_frame_size_received => 16384..16777215, max_frame_size_sent => 16384..16777215 | infinity, preface_timeout => timeout(), settings_timeout => timeout()}

pseudo_headers()

pseudo_headers() = #{} | #{status := cow_http:status()} | #{method := binary(), authority := binary()} | #{method := binary(), scheme := binary(), authority := binary(), path := binary(), protocol => binary()}

Function Index

Function Details

frame/2

frame(Frame::cow_http2:frame(), State) -> {ok, State} | {ok, {data, cow_http2:streamid(), cow_http2:fin(), binary()}, State} | {ok, {headers, cow_http2:streamid(), cow_http2:fin(), cow_http:headers(), pseudo_headers(), non_neg_integer() | undefined}, State} | {ok, {trailers, cow_http2:streamid(), cow_http:headers()}, State} | {ok, {rst_stream, cow_http2:streamid(), cow_http2:error()}, State} | {ok, {push_promise, cow_http2:streamid(), cow_http2:streamid(), cow_http:headers(), pseudo_headers()}, State} | {ok, {goaway, cow_http2:streamid(), cow_http2:error(), binary()}, State} | {send, [{cow_http2:streamid(), cow_http2:fin(), [{data, iodata()} | #sendfile{offset = non_neg_integer(), bytes = pos_integer(), path = file:name_all()} | {trailers, cow_http:headers()}]}], State} | {error, {stream_error, cow_http2:streamid(), cow_http2:error(), atom()}, State} | {error, {connection_error, cow_http2:error(), atom()}, State}

State = http2_machine()

get_last_streamid/1

get_last_streamid(Http2_machine::http2_machine()) -> cow_http2:streamid()

get_local_setting/2

get_local_setting(Key::atom(), Http2_machine::http2_machine()) -> atom() | integer()

get_stream_local_state/2

get_stream_local_state(StreamID::cow_http2:streamid(), State::http2_machine()) -> {ok, idle | cow_http2:fin(), empty | nofin | fin} | {error, not_found | closed}

get_stream_remote_state/2

get_stream_remote_state(StreamID::cow_http2:streamid(), State::http2_machine()) -> {ok, idle | cow_http2:fin()} | {error, not_found | closed}

ignored_frame/1

ignored_frame(State) -> {ok, State} | {error, {connection_error, protocol_error, atom()}, State}

State = http2_machine()

init/2

init(X1::client | server, Opts::opts()) -> {ok, iodata(), http2_machine()}

init_stream/2

init_stream(Method::binary(), State) -> {ok, cow_http2:streamid(), State}

State = http2_machine()

init_upgrade_stream/2

init_upgrade_stream(Method::binary(), State) -> {ok, cow_http2:streamid(), State}

State = http2_machine()

prepare_headers/5

prepare_headers(StreamID::cow_http2:streamid(), State, IsFin0::idle | cow_http2:fin(), PseudoHeaders::pseudo_headers(), Headers0::cow_http:headers()) -> {ok, cow_http2:fin(), iodata(), State}

State = http2_machine()

prepare_push_promise/4

prepare_push_promise(StreamID::cow_http2:streamid(), State, PseudoHeaders::pseudo_headers(), Headers0::cow_http:headers()) -> {ok, cow_http2:streamid(), iodata(), State} | {error, no_push}

State = http2_machine()

prepare_trailers/3

prepare_trailers(StreamID::cow_http2:streamid(), State, Trailers::cow_http:headers()) -> {ok, iodata(), State}

State = http2_machine()

reset_stream/2

reset_stream(StreamID::cow_http2:streamid(), State) -> {ok, State} | {error, not_found}

State = http2_machine()

send_or_queue_data/4

send_or_queue_data(StreamID::cow_http2:streamid(), State, IsFin0::cow_http2:fin(), DataOrFileOrTrailers) -> {ok, State} | {send, [{cow_http2:streamid(), cow_http2:fin(), [DataOrFileOrTrailers]}], State}

State = http2_machine()
DataOrFileOrTrailers = {data, iodata()} | #sendfile{offset = non_neg_integer(), bytes = pos_integer(), path = file:name_all()} | {trailers, cow_http:headers()}

timeout/3

timeout(X1::preface_timeout | settings_timeout, TRef::reference(), State) -> {ok, State} | {error, {connection_error, cow_http2:error(), atom()}, State}