Liking cljdoc? Tell your friends :D

Machine Head, a Clojure MQTT Client

Machine Head is a Clojure MQTT client.

Project Goals

  • Cover all (or nearly all) MQTT v3 features
  • Be well documented
  • Be well tested
  • Provide a convenient API (Paho Java's API is poorly designed)
  • Don't introduce a lot of latency and throughput overhead

Community

Machine Head has a mailing list. Feel free to join it and ask any questions you may have.

To subscribe for announcements of releases, important changes and so on, please follow @ClojureWerkz on Twitter.

Project Maturity

Machine Head is very young and not complete. However, the key functionality (connections, publishing, subscriptions) is supported. Barring the fact that documentation is work in progress, we encourage you to give the library a try.

The API for key operations may changes in the future, although this is fairly unlikely, given how small the library is.

Artifacts

Machine Head artifacts are released to Clojars. If you are using Maven, add the following repository definition to your pom.xml:

<repository>
  <id>clojars.org</id>
  <url>http://clojars.org/repo</url>
</repository>

The Most Recent Release

With Leiningen:

[clojurewerkz/machine_head "1.0.0-beta9"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>machine_head</artifactId>
  <version>1.0.0-beta9</version>
</dependency>

Documentation & Examples

Guides

Machine Head documentation guides are work in progress:

API Reference

API reference is also available.

Examples

Code examples are available in a separate repository.

Supported MQTT Broker Implementations

Machine Head is tested against RabbitMQ with MQTT plugin and Mosquitto.

Supported Clojure Versions

Machine Head requires Clojure 1.6+.

Continuous Integration Status

Continuous Integration status

Machine Head Is a ClojureWerkz Project

Machine Head is part of the group of Clojure libraries known as ClojureWerkz, together with

and several others.

Development

Machine Head uses Leiningen 2. Make sure you have it installed and then run tests against supported Clojure versions using

lein all test

Then create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request on GitHub.

License

Copyright (C) 2014-2016 Michael S. Klishin, Alex Petrov, and the ClojureWerkz Team.

Double licensed under the Eclipse Public License (the same as Clojure) or the Apache Public License 2.0.

Can you improve this documentation? These fine people already did:
Michael Klishin, Hiroshi Fukada & Bitdeli Chef
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close