summaryrefslogtreecommitdiff
path: root/src/pmon.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/pmon.erl')
-rw-r--r--src/pmon.erl13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/pmon.erl b/src/pmon.erl
index a94f5a67af..7981742284 100644
--- a/src/pmon.erl
+++ b/src/pmon.erl
@@ -16,6 +16,19 @@
-module(pmon).
+%% Process Monitor
+%% ================
+%%
+%% This module monitors processes so that every process has at most
+%% 1 monitor.
+%% Processes monitored can be dynamically added and removed.
+%%
+%% Unlike erlang:[de]monitor* functions, this module
+%% provides basic querying capability and avoids contacting down nodes.
+%%
+%% 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]).