Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 65 lines (36 sloc) 1.656 kB
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
1 erlzmq2
e5fb493 @yrashk Added initial README.md
yrashk authored
2 ====
3 NIF based Erlang bindings for the ZeroMQ messaging library.
4
91b4e62 @okeuday Make the NIF more robust. Guard non-reentrant ZeroMQ sockets. Provi…
okeuday authored
5 Copyright (c) 2011 Yurii Rashkovskii, Evax Software and Michael Truog
e5fb493 @yrashk Added initial README.md
yrashk authored
6
7 Overview
8 ========
9
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
10 The erlzmq2 application provides high-performance NIF based Erlang bindings
e5fb493 @yrashk Added initial README.md
yrashk authored
11 for the ZeroMQ messaging library.
12
13 Downloading
14 ===========
15
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
16 The erlzmq2 source code can be found on [GitHub](https://github.com/yrashk/erlzmq2)
e5fb493 @yrashk Added initial README.md
yrashk authored
17
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
18 $ git clone http://github.com/yrashk/erlzmq2.git
e5fb493 @yrashk Added initial README.md
yrashk authored
19
20 It is also available on [Agner](http://erlagner.org/):
21
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
22 $ agner build erlzmq
e5fb493 @yrashk Added initial README.md
yrashk authored
23
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
24 In order to build erlzmq2 against a specific version of ZeroMQ (not `master`), use this:
3689d57 @yrashk Updated documentation on building from agner
yrashk authored
25
baa8345 @yrashk Renamed ezmq to erlzmq2
yrashk authored
26 $ ZEROMQ_VERSION=v<VERSION> agner build erlzmq
3689d57 @yrashk Updated documentation on building from agner
yrashk authored
27
e5fb493 @yrashk Added initial README.md
yrashk authored
28 Building
29 ========
30
31 Build the code
32
33 $ make
34
b7a25c1 @yrashk Use scripted cloning for zerom2 so that zeromq version can be passed …
yrashk authored
35 If you want to build against a specific version of ZeroMQ (not `master`), use this:
36
37 $ ZEROMQ_VERSION=v<VERSION> make
38
e5fb493 @yrashk Added initial README.md
yrashk authored
39 Build the docs
40
41 $ make docs
42
43 Run the test suite
44
45 $ make test
46
99d4931 @evax Add benchmarking tool
evax authored
47 Run the benchmarks (requires [python](http://www.python.org) and [matplotlib](http://matplotlib.sourceforge.net/))
48
49 $ make bench
50
51 This will run performance tests and output png graphs in the graphs directory.
52
578b6fc @evax Sync README file with the edoc overview
evax authored
53 Please note that to behave properly on your system ZeroMQ might require [some tuning](http://www.zeromq.org/docs:tuning-zeromq).
54
55 Architecture
56 ============
57
58 The bindings use Erlang's [NIF (native implemented functions)](http://www.erlang.org/doc/man/erl_nif.html) interface to achieve the best performance. One extra OS thread and one pair of inproc sockets by context are used to simulate blocking recv calls without affecting the Erlang virtual machine's responsiveness.
59
60 License
61 =======
62
63 The project is released under the MIT license.
e5fb493 @yrashk Added initial README.md
yrashk authored
64
Something went wrong with that request. Please try again.