Page MenuHomeDevCentral
Files F10770541

README.md
No OneTemporary
Actions

README.md
View Options

# RabbitMQ TCL
This library is a wrapper around [rabbitmq-c](https://github.com/alanxz/rabbitmq-c).
It exposes the C functions allowing to interact with a RabbitMQ server in TCL.
Work in progress, it's currently usable to publish or get a message, but a lot
of API functions still need to be implemented. You can open an issue if you need
something. If you wish to submit code, mq_bindqueue is a good starting point to
show how the TCL command handling and the API wrapping work.
## User starting guide
### Installation
```
git clone https://github.com/dereckson/rabbitmq-tcl.git
cd rabbitmq-tcl
make
```
### How to use it?
**To load the library:**
```
load rabbitmq.so
```
**You'll then got a mq command to interact with your broker:**
```
mq connect [broker.domain.tld[:port]] [username] [password] [vhost]
mq disconnect
```
**To publish a message:**
```
mq publish <target> [-key <routing key>] [-mandatory] [-immediate] <message>
```
The target could be directly an exchange name, or use the following syntax:
`[-exchange <exchange name>] [-queue <queue name>]`
**To get a message:**
The prefered way is asynchronously.
But you can also use the synchronous basic.get implementation:
```
mq get <queue> [-noack]
```
Currently, basic.ack isn't implemented, so add -noack if you don't want the
broker send again the same messages at the next session.
**To bind a queue to an exchange:**
Creates a temporary autodelete queue
```
mq bindqueue <exchange> [bindingKey]
```
If the exchange doesn't exist, it will be created (in mode topic).
With RabbitMQ, the queue will be named randomly starting by `amq.gen-` and be
be deleted if consumed.
Please note `mq get` doesn't consume, it provides direct access instead.
### Multiple connections
If you need to use more than one connectionn, you've also aliases mq1 to mq10:
```
mq3 connect
mq3 disconnect
```
## Customize the build
### config.h
If you want to be able to use different default values, you can edit the defines
at `src/config.h`, then rebuild the extension.
### E4C
This extension is a wrapper around librabbitmq, which is not bulletproof against
null pointer errors.
In a critical context, we suggest to enable e4c. If a command `mq quux` would
try to use a NULL pointer, instead of segfault, you would get a TCL error,
and then would be able to resume operations:
```
% mq quux
Segmentation violation.
%
```
## Licensing
(c) 2015, Nasqueron, some rights reserved.
Released under BSD-2-Clause license.
This work includes the exceptions4c library.
(c) 2013 Guillermo Calvo
Released under LGPL license.
### Note if you relicense a derivative work
If you create any derivative work of this library, you must do one of the
following actions:
* drop exceptions4c support (rm vendor/e4c and the #ifdef USE_E4C blocks)
* release the whole work under LGPLv3 or GPLv3
* publish source code or object form (.o) so it's possible to relink
against another version of exceptions4c [this is what we do]
According http://www.gnu.org/licenses/gpl-faq.html#LGPLStaticVsDynamic, you can
link staticly against a LGPL library as long as you provide the .o object of
your application stripped of the LGPL code or provide the source code and build
tools to achieve it.
## Misc
### Acknowledgment
* Alan Antonuk, rabbitmq-c maintainer
* Fastbase, which provides [fbsql](http://www.fastbase.co.nz/fbsql/fbsql.c),
which is used as the model and starting point for this library.
### Colophon
This work has been created for Nasqueron, to allow their operations and
infrastructure TCL code to interact to our message broker.
**Editors used:** vim, Cloud9
**Tools used:** Arcanist, clang-format
**Compiler:** clang/llvm

File Metadata

Mime Type
text/plain
Expires
Mon, Jul 28, 09:46 (1 d, 54 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2845862
Default Alt Text
README.md (3 KB)

Event Timeline

Nasqueron DevCentral · If it had been much bigger the moon would have had a core of ice. · Powered by Phabricator