This repository is used to package and release the Ruby gem czmq-ffi-gen, the low-level Ruby FFI binding for CZMQ. The gem czmq-ffi-gen can be used as a base for a higher-level CZMQ binding like CZTop. But of course you can use it for anything you want. :-)
This is generated code. It is generated from the API models in CZMQ using zproject. It doesn't feel like Ruby. It's not intended to be used directly. Instead, use CZTop, or write your own wrapper for this library.
Generated code isn't actually in this repository
The actual generated code lies in CZMQ, which is a Git submodule of this
repository, registered under
vendor/czmq. So if you're not happy with any of
the generated code, go have a closer look at
zproject, which is used by CZMQ to
generate the low-level binding).
For that same reason, API documentation of unreleased code (directly off this repository), like rubydoc.info/github/paddor/czmq-ffi-gen does NOT include any of the generated code. Rubydoc.info doesn't check out Git submodules as part of its documentation procedure.
However, the API documentation of the released gem should include all the code, as the gem release process will include all required source files directly within the gem.
Check out http://www.rubydoc.info/gems/czmq-ffi-gen for the API documentation for the released gem.
- CZMQ >= 4.1
- ZMQ >= 4.2
For security mechanisms like CURVE, you can use an external library:
On macOS using homebrew, run:
$ brew install czmq
If you're running Linux, go check this page to get more help. Make sure to install CZMQ, not only ZMQ.
The latest MRI (currently the 2.6 series) is tested on CI.
The following SHOULD work, but are untested:
- JRuby 9000
To use this gem, add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install czmq-ffi-gen
Check out CZTop or the API documentation to see how this project can be used. :-)
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive
prompt that will allow you to experiment.