Browse files

Document the performance implications of socket modes

  • Loading branch information...
1 parent 99d4931 commit dad60babcb262405d2e1dd9163ebf0e51ceaf15f @evax evax committed Mar 30, 2011
Showing with 13 additions and 1 deletion.
  1. +6 −0 doc/overview.edoc
  2. +7 −1 src/erlzmq.erl
View
6 doc/overview.edoc
@@ -62,6 +62,12 @@ Run the test suite
$ make test
'''
+Run the benchmarks (requires [http://www.python.org python] and [http://matplotlib.sourceforge.net matplotlib])
+```
+ $ make bench
+'''
+This will run performance tests and output png graphs in the graphs directory.
+
Please note that to behave properly on your system ZeroMQ might require [http://www.zeromq.org/docs:tuning-zeromq some tuning].
== Architecture ==
View
8 src/erlzmq.erl
@@ -75,7 +75,13 @@ context(Threads) when is_integer(Threads) ->
%% <br />
%% If the socket can be created an 'ok' tuple containing a
%% {@type erlzmq_socket()} handle to the created socket is returned;
-%% if not, it returns an {@type erlzmq_error()} describing the error.<br />
+%% if not, it returns an {@type erlzmq_error()} describing the error.
+%% <br />
+%% In line with Erlang's socket paradigm, a socket can be either active or
+%% passive. Passive sockets tend to have lower latency and have a higher
+%% throughput for small message sizes. Active sockets on the contrary give
+%% the highest throughput for messages above 32k. A benchmarking tool is
+%% included in the source distribution.
%% <i>For more information see
%% <a href="http://api.zeromq.org/master:zmq_socket">zmq_socket</a>.</i>
%% @end

0 comments on commit dad60ba

Please sign in to comment.