diff options
author | Loïc Hoguin <[email protected]> | 2019-05-08 14:01:51 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2019-05-08 14:01:51 +0200 |
commit | cfd702a716f834c431abd46532e8cfa4debd1468 (patch) | |
tree | 3b7f76792a5459fb577e0b661c79a0f6135ca884 /src/gun_event.erl | |
parent | 3e62d24573c91c04eb9af5d7ba47f2c16d1948de (diff) | |
download | gun-cfd702a716f834c431abd46532e8cfa4debd1468.tar.gz gun-cfd702a716f834c431abd46532e8cfa4debd1468.tar.bz2 gun-cfd702a716f834c431abd46532e8cfa4debd1468.zip |
Add event_handler with init/connect_start/connect_end
Diffstat (limited to 'src/gun_event.erl')
-rw-r--r-- | src/gun_event.erl | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/src/gun_event.erl b/src/gun_event.erl new file mode 100644 index 0000000..fffcafe --- /dev/null +++ b/src/gun_event.erl @@ -0,0 +1,72 @@ +%% Copyright (c) 2019, Loïc Hoguin <[email protected]> +%% +%% Permission to use, copy, modify, and/or distribute this software for any +%% purpose with or without fee is hereby granted, provided that the above +%% copyright notice and this permission notice appear in all copies. +%% +%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +-module(gun_event). + +%% init. + +-type init_event() :: #{ + owner := pid(), + transport := tcp | tls, + origin_scheme := binary(), + origin_host := inet:hostname() | inet:ip_address(), + origin_port := inet:port_number(), + opts := gun:opts() +}. + +-callback init(init_event(), State) -> State. + +%% connect_start/connect_end. + +-type connect_event() :: #{ + host := inet:hostname() | inet:ip_address(), + port := inet:port_number(), + transport := tcp | tls, + transport_opts := [gen_tcp:connect_option()] | [ssl:connect_option()], + timeout := timeout(), + socket => inet:socket() | ssl:sslsocket() | pid(), + protocol => http | http2, + error => any() +}. + +-callback connect_start(connect_event(), State) -> State. +-callback connect_end(connect_event(), State) -> State. + +%% @todo domain_lookup_start +%% @todo domain_lookup_end +%% @todo tls_handshake_start +%% @todo tls_handshake_end +%% @todo origin_changed +%% @todo transport_changed +%% @todo protocol_changed +%% @todo disconnected +%% @todo terminate +%% @todo stream_start +%% @todo stream_end +%% @todo request_start +%% @todo request_headers +%% @todo request_end +%% @todo response_start (call it once per inform + one for the response) +%% @todo response_inform +%% @todo response_headers +%% @todo response_end +%% @todo push_promise_start +%% @todo push_promise_end +%% @todo ws_upgrade_start +%% @todo ws_upgrade_end +%% @todo ws_frame_read_start +%% @todo ws_frame_read_header +%% @todo ws_frame_read_end +%% @todo ws_frame_write_start +%% @todo ws_frame_write_end |