summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Klishin <michael@rabbitmq.com>2015-02-03 09:33:01 +0300
committerMichael Klishin <michael@rabbitmq.com>2015-02-03 09:33:01 +0300
commit77b938552c912857fd88cc3aee50405765cff7b6 (patch)
tree7b1fa4d95e5c74763b465781efb5bc28f6357892
parent5d07cfc33963e718f7c75cfda27a1ffd63f2016e (diff)
downloadrabbitmq-server-git-77b938552c912857fd88cc3aee50405765cff7b6.tar.gz
Basic documentation for pmon
-rw-r--r--src/pmon.erl12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/pmon.erl b/src/pmon.erl
index a94f5a67af..e482429ef4 100644
--- a/src/pmon.erl
+++ b/src/pmon.erl
@@ -16,6 +16,18 @@
-module(pmon).
+%% Process Monitor
+%% ================
+%%
+%% This module provides a way to monitor processes.
+%% Processes monitored can be dynamically added and removed.
+%%
+%% Unlike erlang:[de]monitor* functions, this module keeps a dictionary
+%% of monitored processes and provides basic querying capability.
+%%
+%% It is used to monitor nodes, queue mirrors, and by
+%% the queue collector, among other things.
+
-export([new/0, new/1, monitor/2, monitor_all/2, demonitor/2,
is_monitored/2, erase/2, monitored/1, is_empty/1]).