Module gun

Data Types

headers()

headers() = [{binary(), iodata()}]

http2_opts()

http2_opts() = #{}

http_opts()

http_opts() = #{}

opts()

opts() = #{}

req_opts()

req_opts() = #{}

ws_close_code()

ws_close_code() = 1000..4999

ws_frame()

ws_frame() = close | ping | pong | {text | binary | close | ping | pong, iodata()} | {close, ws_close_code(), iodata()}

ws_opts()

ws_opts() = #{}

Function Index

await/2
await/3
await/4
await_body/2
await_body/3
await_body/4
await_up/1
await_up/2
await_up/3
cancel/2
close/1
data/4
dbg_send_raw/2
delete/2
delete/3
delete/4
flush/1
get/2
get/3
get/4
head/2
head/3
head/4
info/1
open/2
open/3
options/2
options/3
options/4
patch/3
patch/4
patch/5
post/3
post/4
post/5
proc_lib_hack/5
put/3
put/4
put/5
request/4
request/5
request/6
shutdown/1
start_link/4
system_code_change/4
system_continue/3
system_terminate/4
ws_send/2
ws_upgrade/2
ws_upgrade/3
ws_upgrade/4

Function Details

await/2

await(ServerPid, StreamRef) -> any()

await/3

await(ServerPid, StreamRef, MRef) -> any()

await/4

await(ServerPid, StreamRef, Timeout, MRef) -> any()

await_body/2

await_body(ServerPid, StreamRef) -> any()

await_body/3

await_body(ServerPid, StreamRef, MRef) -> any()

await_body/4

await_body(ServerPid, StreamRef, Timeout, MRef) -> any()

await_up/1

await_up(ServerPid::pid()) -> {ok, http | http2} | {error, atom()}

await_up/2

await_up(ServerPid::pid(), MRef::reference() | timeout()) -> {ok, http | http2} | {error, atom()}

await_up/3

await_up(ServerPid::pid(), Timeout::timeout(), MRef::reference()) -> {ok, http | http2} | {error, atom()}

cancel/2

cancel(ServerPid::pid(), StreamRef::reference()) -> ok

close/1

close(ServerPid::pid()) -> ok

data/4

data(ServerPid::pid(), StreamRef::reference(), IsFin::fin | nofin, Data::iodata()) -> ok

dbg_send_raw/2

dbg_send_raw(ServerPid::pid(), Data::iodata()) -> ok

delete/2

delete(ServerPid::pid(), Path::iodata()) -> reference()

delete/3

delete(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

delete/4

delete(ServerPid::pid(), Path::iodata(), Headers::headers(), ReqOpts::req_opts()) -> reference()

flush/1

flush(ServerPid::pid() | reference()) -> ok

get/2

get(ServerPid::pid(), Path::iodata()) -> reference()

get/3

get(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

get/4

get(ServerPid::pid(), Path::iodata(), Headers::headers(), ReqOpts::req_opts()) -> reference()

head/2

head(ServerPid::pid(), Path::iodata()) -> reference()

head/3

head(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

head/4

head(ServerPid::pid(), Path::iodata(), Headers::headers(), ReqOpts::req_opts()) -> reference()

info/1

info(ServerPid::pid()) -> #{}

open/2

open(Host::inet:hostname(), Port::inet:port_number()) -> {ok, pid()} | {error, any()}

open/3

open(Host::inet:hostname(), Port::inet:port_number(), Opts::opts()) -> {ok, pid()} | {error, any()}

options/2

options(ServerPid::pid(), Path::iodata()) -> reference()

options/3

options(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

options/4

options(ServerPid::pid(), Path::iodata(), Headers::headers(), ReqOpts::req_opts()) -> reference()

patch/3

patch(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

patch/4

patch(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata()) -> reference()

patch/5

patch(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata(), ReqOpts::req_opts()) -> reference()

post/3

post(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

post/4

post(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata()) -> reference()

post/5

post(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata(), ReqOpts::req_opts()) -> reference()

proc_lib_hack/5

proc_lib_hack(Parent, Owner, Host, Port, Opts) -> any()

put/3

put(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

put/4

put(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata()) -> reference()

put/5

put(ServerPid::pid(), Path::iodata(), Headers::headers(), Body::iodata(), ReqOpts::req_opts()) -> reference()

request/4

request(ServerPid::pid(), Method::iodata(), Path::iodata(), Headers::headers()) -> reference()

request/5

request(ServerPid::pid(), Method::iodata(), Path::iodata(), Headers::headers(), Body::iodata()) -> reference()

request/6

request(ServerPid::pid(), Method::iodata(), Path::iodata(), Headers::headers(), Body::iodata(), ReqOpts::req_opts()) -> reference()

shutdown/1

shutdown(ServerPid::pid()) -> ok

start_link/4

start_link(Owner, Host, Port, Opts) -> any()

system_code_change/4

system_code_change(Misc, X2, X3, X4) -> any()

system_continue/3

system_continue(X1, X2, X3) -> any()

system_terminate/4

system_terminate(Reason::any(), X2::term(), X3::term(), X4::term()) -> no_return()

ws_send/2

ws_send(ServerPid::pid(), Frames::ws_frame() | [ws_frame()]) -> ok

ws_upgrade/2

ws_upgrade(ServerPid::pid(), Path::iodata()) -> reference()

ws_upgrade/3

ws_upgrade(ServerPid::pid(), Path::iodata(), Headers::headers()) -> reference()

ws_upgrade/4

ws_upgrade(ServerPid::pid(), Path::iodata(), Headers::headers(), Opts::ws_opts()) -> reference()


Generated by EDoc, Jan 16 2018, 19:57:52.