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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
%% Copyright (c) 2012, 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.
%% @private
-module(ranch_server).
-behaviour(gen_server).
%% API.
-export([start_link/0]).
-export([insert_listener/2]).
-export([lookup_listener/1]).
-export([set_connections_sup/2]).
-export([lookup_connections_sup/1]).
-export([add_acceptor/2]).
-export([send_to_acceptors/2]).
-export([add_connection/1]).
-export([count_connections/1]).
-export([remove_connection/1]).
-export([add_connections_counter/1]).
-export([remove_connections_counter/1]).
%% gen_server.
-export([init/1]).
-export([handle_call/3]).
-export([handle_cast/2]).
-export([handle_info/2]).
-export([terminate/2]).
-export([code_change/3]).
-define(TAB, ?MODULE).
-type key() :: {listener | acceptors, any()}.
-type monitors() :: [{{reference(), pid()}, key()}].
-record(state, {
monitors = [] :: monitors()
}).
%% API.
%% @doc Start the ranch_server gen_server.
-spec start_link() -> {ok, pid()}.
start_link() ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
%% @doc Insert a listener into the database.
-spec insert_listener(any(), pid()) -> ok.
insert_listener(Ref, Pid) ->
true = ets:insert_new(?TAB, {{listener, Ref}, Pid, undefined}),
gen_server:cast(?MODULE, {insert_listener, Ref, Pid}).
%% @doc Lookup a listener in the database.
-spec lookup_listener(any()) -> pid().
lookup_listener(Ref) ->
ets:lookup_element(?TAB, {listener, Ref}, 2).
%% @doc Set a connection supervisor associated with specific listener.
-spec set_connections_sup(any(), pid()) -> ok.
set_connections_sup(Ref, Pid) ->
true = ets:update_element(?TAB, {listener, Ref}, {3, Pid}),
ok.
%% @doc Lookup a connection supervisor used by specific listener.
-spec lookup_connections_sup(any()) -> pid() | undefined.
lookup_connections_sup(Ref) ->
ets:lookup_element(?TAB, {listener, Ref}, 3).
%% @doc Add an acceptor for the given listener.
-spec add_acceptor(any(), pid()) -> ok.
add_acceptor(Ref, Pid) ->
gen_server:cast(?MODULE, {add_acceptor, Ref, Pid}).
%% @doc Send a message to all acceptors of the given listener.
-spec send_to_acceptors(any(), any()) -> ok.
send_to_acceptors(Ref, Msg) ->
Acceptors = ets:lookup_element(?TAB, {acceptors, Ref}, 2),
_ = [Pid ! Msg || Pid <- Acceptors],
ok.
%% @doc Add a connection to the connection pool.
%%
%% Also return the number of connections in the pool after this operation.
-spec add_connection(pid()) -> non_neg_integer().
add_connection(ListenerPid) ->
ets:update_counter(?TAB, {connections, ListenerPid}, 1).
%% @doc Count the number of connections in the connection pool.
-spec count_connections(pid()) -> non_neg_integer().
count_connections(ListenerPid) ->
try
ets:update_counter(?TAB, {connections, ListenerPid}, 0)
catch
error:badarg -> % Max conns = infinity
0
end.
%% @doc Remove a connection from the connection pool.
%%
%% Also return the number of connections in the pool after this operation.
-spec remove_connection(pid()) -> non_neg_integer().
remove_connection(ListenerPid) ->
ets:update_counter(?TAB, {connections, ListenerPid}, -1).
%% @doc Add a connections counter to the connection pool
%%
%% Should only be used by ranch listeners when settings regarding the max
%% number of connections change.
add_connections_counter(Pid) ->
true = ets:insert_new(?TAB, {{connections, Pid}, 0}).
%% @doc remove a connections counter from the connection pool
%%
%% Should only be used by ranch listeners when settings regarding the max
%% number of connections change.
remove_connections_counter(Pid) ->
true = ets:delete(?TAB, {connections, Pid}).
%% gen_server.
%% @private
init([]) ->
{ok, #state{}}.
%% @private
handle_call(_Request, _From, State) ->
{reply, ignore, State}.
%% @private
handle_cast({insert_listener, Ref, Pid}, State=#state{monitors=Monitors}) ->
true = ets:insert_new(?TAB, {{acceptors, Ref}, []}),
MonitorRef = erlang:monitor(process, Pid),
{noreply, State#state{
monitors=[{{MonitorRef, Pid}, {listener, Ref}}|Monitors]}};
handle_cast({add_acceptor, Ref, Pid}, State=#state{monitors=Monitors}) ->
MonitorRef = erlang:monitor(process, Pid),
Acceptors = ets:lookup_element(?TAB, {acceptors, Ref}, 2),
true = ets:insert(?TAB, {{acceptors, Ref}, [Pid|Acceptors]}),
{noreply, State#state{
monitors=[{{MonitorRef, Pid}, {acceptors, Ref}}|Monitors]}};
handle_cast({add_connection, Pid}, State) ->
_ = erlang:monitor(process, Pid),
{noreply, State};
handle_cast(_Request, State) ->
{noreply, State}.
%% @private
handle_info({'DOWN', MonitorRef, process, Pid, _},
State=#state{monitors=Monitors}) ->
{_, Key} = lists:keyfind({MonitorRef, Pid}, 1, Monitors),
Monitors2 = remove_process(Key, MonitorRef, Pid, Monitors),
{noreply, State#state{monitors=Monitors2}};
handle_info(_Info, State) ->
{noreply, State}.
%% @private
terminate(_Reason, _State) ->
ok.
%% @private
code_change(_OldVsn, State, _Extra) ->
{ok, State}.
%% Internal.
-spec remove_process(key(), reference(), pid(), Monitors)
-> Monitors when Monitors::monitors() .
remove_process(Key = {listener, Ref}, MonitorRef, Pid, Monitors) ->
true = ets:delete(?TAB, Key),
true = ets:delete(?TAB, {acceptors, Ref}),
remove_connections_counter(Pid),
lists:keydelete({MonitorRef, Pid}, 1, Monitors);
remove_process(Key = {acceptors, _}, MonitorRef, Pid, Monitors) ->
try
Acceptors = ets:lookup_element(?TAB, Key, 2),
true = ets:update_element(?TAB, Key, {2, lists:delete(Pid, Acceptors)})
catch
error:_ ->
ok
end,
lists:keydelete({MonitorRef, Pid}, 1, Monitors).
|
