aboutsummaryrefslogtreecommitdiffstats
path: root/src/ranch_server.erl
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-12-07 15:28:02 +0100
committerLoïc Hoguin <[email protected]>2013-12-07 15:28:02 +0100
commit20a48ce65e0f14898e5027df080ec01813c1feb0 (patch)
treeacaf269cba2984316eedeccab55f577a24e82f83 /src/ranch_server.erl
parent3634e392a8634eb716210204999f3b4c481dd4b1 (diff)
downloadranch-20a48ce65e0f14898e5027df080ec01813c1feb0.tar.gz
ranch-20a48ce65e0f14898e5027df080ec01813c1feb0.tar.bz2
ranch-20a48ce65e0f14898e5027df080ec01813c1feb0.zip
Get rid of a ton of pointless comments
All of it can be found in the manual, which defines what the code must do, and is always up to date unlike the code comments.
Diffstat (limited to 'src/ranch_server.erl')
-rw-r--r--src/ranch_server.erl21
1 files changed, 1 insertions, 20 deletions
diff --git a/src/ranch_server.erl b/src/ranch_server.erl
index 0b21cce..2e74248 100644
--- a/src/ranch_server.erl
+++ b/src/ranch_server.erl
@@ -1,4 +1,4 @@
-%% Copyright (c) 2012, Loïc Hoguin <[email protected]>
+%% Copyright (c) 2012-2013, 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
@@ -12,7 +12,6 @@
%% 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).
@@ -47,17 +46,14 @@
%% API.
-%% @doc Start the ranch_server gen_server.
-spec start_link() -> {ok, pid()}.
start_link() ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
-%% @private
-spec set_new_listener_opts(ranch:ref(), ranch:max_conns(), any()) -> ok.
set_new_listener_opts(Ref, MaxConns, Opts) ->
gen_server:call(?MODULE, {set_new_listener_opts, Ref, MaxConns, Opts}).
-%% @doc Cleanup listener options after it has been stopped.
-spec cleanup_listener_opts(ranch:ref()) -> ok.
cleanup_listener_opts(Ref) ->
_ = ets:delete(?TAB, {port, Ref}),
@@ -65,61 +61,50 @@ cleanup_listener_opts(Ref) ->
_ = ets:delete(?TAB, {opts, Ref}),
ok.
-%% @doc Set a connection supervisor associated with specific listener.
-spec set_connections_sup(ranch:ref(), pid()) -> ok.
set_connections_sup(Ref, Pid) ->
true = gen_server:call(?MODULE, {set_connections_sup, Ref, Pid}),
ok.
-%% @doc Return the connection supervisor used by specific listener.
-spec get_connections_sup(ranch:ref()) -> pid().
get_connections_sup(Ref) ->
ets:lookup_element(?TAB, {conns_sup, Ref}, 2).
-%% @private
-spec set_port(ranch:ref(), inet:port_number()) -> ok.
set_port(Ref, Port) ->
gen_server:call(?MODULE, {set_port, Ref, Port}).
-%% @doc Return the listener's port.
-spec get_port(ranch:ref()) -> inet:port_number().
get_port(Ref) ->
ets:lookup_element(?TAB, {port, Ref}, 2).
-%% @doc Set the max number of connections allowed concurrently.
-spec set_max_connections(ranch:ref(), ranch:max_conns()) -> ok.
set_max_connections(Ref, MaxConnections) ->
gen_server:call(?MODULE, {set_max_conns, Ref, MaxConnections}).
-%% @doc Return the max number of connections allowed concurrently.
-spec get_max_connections(ranch:ref()) -> ranch:max_conns().
get_max_connections(Ref) ->
ets:lookup_element(?TAB, {max_conns, Ref}, 2).
-%% @doc Upgrade the protocol options.
-spec set_protocol_options(ranch:ref(), any()) -> ok.
set_protocol_options(Ref, ProtoOpts) ->
gen_server:call(?MODULE, {set_opts, Ref, ProtoOpts}).
-%% @doc Return the current protocol options.
-spec get_protocol_options(ranch:ref()) -> any().
get_protocol_options(Ref) ->
ets:lookup_element(?TAB, {opts, Ref}, 2).
-%% @doc Count the number of connections in the connection pool.
-spec count_connections(ranch:ref()) -> non_neg_integer().
count_connections(Ref) ->
ranch_conns_sup:active_connections(get_connections_sup(Ref)).
%% gen_server.
-%% @private
init([]) ->
Monitors = [{{erlang:monitor(process, Pid), Pid}, Ref} ||
[Ref, Pid] <- ets:match(?TAB, {{conns_sup, '$1'}, '$2'})],
{ok, #state{monitors=Monitors}}.
-%% @private
handle_call({set_new_listener_opts, Ref, MaxConns, Opts}, _, State) ->
ets:insert(?TAB, {{max_conns, Ref}, MaxConns}),
ets:insert(?TAB, {{opts, Ref}, Opts}),
@@ -150,11 +135,9 @@ handle_call({set_opts, Ref, Opts}, _, State) ->
handle_call(_Request, _From, State) ->
{reply, ignore, State}.
-%% @private
handle_cast(_Request, State) ->
{noreply, State}.
-%% @private
handle_info({'DOWN', MonitorRef, process, Pid, _},
State=#state{monitors=Monitors}) ->
{_, Ref} = lists:keyfind({MonitorRef, Pid}, 1, Monitors),
@@ -164,10 +147,8 @@ handle_info({'DOWN', MonitorRef, process, Pid, _},
handle_info(_Info, State) ->
{noreply, State}.
-%% @private
terminate(_Reason, _State) ->
ok.
-%% @private
code_change(_OldVsn, State, _Extra) ->
{ok, State}.