summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Klishin <michael@clojurewerkz.org>2015-12-11 00:49:52 +0300
committerMichael Klishin <michael@clojurewerkz.org>2015-12-11 00:49:52 +0300
commita10485a81a1a6fb598b3f691081497f94f4fca4e (patch)
treee2bd175bd66b52a49cd6a12f926a16b5db369f26
parentd4e0f70ca541d3e0535376ef66014a81f385db1f (diff)
downloadrabbitmq-server-git-a10485a81a1a6fb598b3f691081497f94f4fca4e.tar.gz
Docs
-rw-r--r--src/rabbit_channel_sup.erl10
-rw-r--r--src/rabbit_channel_sup_sup.erl5
-rw-r--r--src/rabbit_connection_helper_sup.erl9
-rw-r--r--src/rabbit_connection_sup.erl9
4 files changed, 33 insertions, 0 deletions
diff --git a/src/rabbit_channel_sup.erl b/src/rabbit_channel_sup.erl
index e8f45f7305..66f6a81697 100644
--- a/src/rabbit_channel_sup.erl
+++ b/src/rabbit_channel_sup.erl
@@ -16,6 +16,16 @@
-module(rabbit_channel_sup).
+%% Supervises processes that implement AMQP 0-9-1 channels:
+%%
+%% * Channel process itself
+%% * Network writer (for network connections)
+%% * Limiter (handles channel QoS and flow control)
+%%
+%% Every rabbit_channel_sup is supervised by rabbit_channel_sup_sup.
+%%
+%% See also rabbit_channel, rabbit_writer, rabbit_limiter.
+
-behaviour(supervisor2).
-export([start_link/1]).
diff --git a/src/rabbit_channel_sup_sup.erl b/src/rabbit_channel_sup_sup.erl
index 2be2af91a7..9cfbb78a2b 100644
--- a/src/rabbit_channel_sup_sup.erl
+++ b/src/rabbit_channel_sup_sup.erl
@@ -16,6 +16,11 @@
-module(rabbit_channel_sup_sup).
+%% Supervisor for AMQP 0-9-1 channels. Every AMQP 0-9-1 connection has
+%% one of these.
+%%
+%% See also rabbit_channel_sup, rabbit_connection_helper_sup, rabbit_reader.
+
-behaviour(supervisor2).
-export([start_link/0, start_channel/2]).
diff --git a/src/rabbit_connection_helper_sup.erl b/src/rabbit_connection_helper_sup.erl
index d3c05ee416..d6492331ef 100644
--- a/src/rabbit_connection_helper_sup.erl
+++ b/src/rabbit_connection_helper_sup.erl
@@ -16,6 +16,15 @@
-module(rabbit_connection_helper_sup).
+%% Supervises auxiliary processes of AMQP 0-9-1 connections:
+%%
+%% * Channel supervisor
+%% * Heartbeat receiver
+%% * Heartbeat sender
+%% * Exclusive queue collector
+%%
+%% See also rabbit_heartbeat, rabbit_channel_sup_sup, rabbit_queue_collector.
+
-behaviour(supervisor2).
-export([start_link/0]).
diff --git a/src/rabbit_connection_sup.erl b/src/rabbit_connection_sup.erl
index a64a2217da..09cddb0247 100644
--- a/src/rabbit_connection_sup.erl
+++ b/src/rabbit_connection_sup.erl
@@ -16,6 +16,15 @@
-module(rabbit_connection_sup).
+%% Supervisor for a (network) AMQP 0-9-1 client connection.
+%%
+%% Supervises
+%%
+%% * rabbit_reader
+%% * Auxiliary process supervisor
+%%
+%% See also rabbit_reader, rabbit_connection_helper_sup.
+
-behaviour(supervisor2).
-behaviour(ranch_protocol).