summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMatthew Sackman <matthew@lshift.net>2010-01-19 16:02:40 +0000
committerMatthew Sackman <matthew@lshift.net>2010-01-19 16:02:40 +0000
commitf46b71cf9d8b0c4f389cad5de80b8efc74cdade9 (patch)
treefe5f193499885d6c39a4fcce1225734878c11421 /src
parentc28ca505c625bf19da0482432596b790f3618ddb (diff)
downloadrabbitmq-server-git-f46b71cf9d8b0c4f389cad5de80b8efc74cdade9.tar.gz
documentation
Diffstat (limited to 'src')
-rw-r--r--src/file_handle_cache.erl8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/file_handle_cache.erl b/src/file_handle_cache.erl
index b289e8427a..723f05aec5 100644
--- a/src/file_handle_cache.erl
+++ b/src/file_handle_cache.erl
@@ -115,6 +115,14 @@
%% fully reopened again as soon as needed, thus users of this library
%% do not need to worry about their handles being closed by the server
%% - reopening them when necessary is handled transparently.
+%%
+%% The server also supports obtain and release_on_death. obtain/0
+%% blocks until a file descriptor is available. release_on_death/1
+%% takes a pid and monitors the pid, reducing the count by 1 when the
+%% pid dies. Thus the assumption is that obtain/0 is called first, and
+%% when that returns, release_on_death/1 is called with the pid who
+%% "owns" the file descriptor. This is, for example, used to track the
+%% use of file descriptors through network sockets.
-behaviour(gen_server).