1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
%% 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.
%% request_start/request_headers.
-type request_start_event() :: #{
stream_ref := reference(),
reply_to := pid(),
function := headers | request,
method := iodata(),
scheme => binary(),
authority := iodata(),
path := iodata(),
headers := [{binary(), iodata()}]
}.
-callback request_start(request_start_event(), State) -> State.
-callback request_headers(request_start_event(), State) -> State.
%% request_end.
-type request_end_event() :: #{
stream_ref := reference(),
reply_to := pid()
}.
-callback request_end(request_end_event(), State) -> State.
%% response_start.
-type response_start_event() :: #{
stream_ref := reference(),
reply_to := pid()
}.
-callback response_start(response_start_event(), State) -> State.
%% response_inform/response_headers.
-type response_headers_event() :: #{
stream_ref := reference(),
reply_to := pid(),
status := non_neg_integer(),
headers := [{binary(), binary()}]
}.
-callback response_inform(response_headers_event(), State) -> State.
-callback response_headers(response_headers_event(), State) -> State.
%% response_trailers.
-type response_trailers_event() :: #{
stream_ref := reference(),
reply_to := pid(),
headers := [{binary(), binary()}]
}.
-callback response_trailers(response_trailers_event(), State) -> State.
%% response_end.
-type response_end_event() :: #{
stream_ref := reference(),
reply_to := pid()
}.
-callback response_end(response_end_event(), State) -> State.
%% disconnect.
-type disconnect_event() :: #{
reason := normal | closed | {error, any()}
}.
-callback disconnect(disconnect_event(), State) -> State.
%% terminate.
-type terminate_event() :: #{
state := not_connected | connected,
reason := normal | shutdown | {shutdown, any()} | any()
}.
-callback terminate(terminate_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 push_promise_start
%% @todo push_promise_end
%% @todo cancel_start
%% @todo cancel_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
|
