diff options
| author | Loïc Hoguin <[email protected]> | 2020-11-09 17:06:05 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2020-11-09 17:06:05 +0100 |
| commit | f4705ecbb9b182e6eaad6b6af0c6fcc17b2251b0 (patch) | |
| tree | b6b87689c0592a257ca43d5850e742b6ddb2a2b6 /src | |
| parent | ffba6390941f40d28d15535c95076dbf0f3c4137 (diff) | |
| download | gun-f4705ecbb9b182e6eaad6b6af0c6fcc17b2251b0.tar.gz gun-f4705ecbb9b182e6eaad6b6af0c6fcc17b2251b0.tar.bz2 gun-f4705ecbb9b182e6eaad6b6af0c6fcc17b2251b0.zip | |
Add the gun_event manual
Diffstat (limited to 'src')
| -rw-r--r-- | src/gun_event.erl | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/src/gun_event.erl b/src/gun_event.erl index e1926d0..b495ba2 100644 --- a/src/gun_event.erl +++ b/src/gun_event.erl @@ -49,7 +49,7 @@ lookup_info := gun_tcp:lookup_info(), timeout := timeout(), socket => inet:socket(), - protocol => http | http2 | socks, %% Only when transport is tcp. + protocol => http | http2 | socks | raw, %% Only when transport is tcp. error => any() }. -export_type([connect_event/0]). @@ -70,7 +70,7 @@ socket := inet:socket() | ssl:sslsocket() | pid(), %% The socket before/after will be different. tls_opts := [ssl:tls_client_option()], timeout := timeout(), - protocol => http | http2 | socks, + protocol => http | http2 | socks | raw, error => any() }. -export_type([tls_handshake_event/0]). @@ -254,8 +254,8 @@ %% event, following a successful CONNECT request or a SOCKS tunnel. -type protocol_changed_event() :: #{ - stream_ref := gun:stream_ref(), - protocol := http | http2 | socks | ws + stream_ref => gun:stream_ref(), + protocol := http | http2 | socks | raw | ws }. -export_type([protocol_changed_event/0]). @@ -264,8 +264,8 @@ %% origin_changed. -type origin_changed_event() :: #{ - stream_ref := gun:stream_ref(), - type := connect, %% @todo socks? + stream_ref => gun:stream_ref(), + type := connect | socks5, origin_scheme := binary(), origin_host := inet:hostname() | inet:ip_address(), origin_port := inet:port_number() @@ -306,7 +306,9 @@ %% terminate. -type terminate_event() :: #{ - state := not_connected | domain_lookup | connecting | tls_handshake | connected, + state := not_connected + | domain_lookup | connecting | initial_tls_handshake | tls_handshake + | connected | connected_data_only | connected_ws_only, reason := normal | shutdown | {shutdown, any()} | any() }. -export_type([terminate_event/0]). |