Eclipse zenoh Java Client API

The Java API for Eclipse zenoh, based on the zenoh-c API via JNI.

⚠️ zenoh has been subject to a complete rewrite with major protocol updates between versions 0.4.2 and 0.5.0. The Java API does not yet integrate those changes and is only compatible with version 0.4.2 of the zenoh daemon and the underlying zenoh-c stack.

Installation

zenoh-java is available on Maven Central. Just add the dependency in your POM:

  <dependency>
    <groupId>org.eclipse.zenoh</groupId>
    <artifactId>zenoh</artifactId>
    <version>0.4.2-M1</version>
  </dependency>

Building

Requirements:

• Java >= 8
• Apache Maven >= 3.6.0
• SWIG
• CMake
• make, gcc (for zenoh-c compilation)

Optional for cross-compilation:

• Docker

To build for your current platform: mvn clean install

If zenoh-c is found in the same directory than zenoh-java, the build will copy its sources and compile it. Otherwise, the build will clone the zenoh-c repository and compile it.

Note that this Maven build offers profiles in addition of the default one:

• mvn -Pdebug clean install

  • compiles zenoh-c with debug logs active

• mvn -Prelease clean install

  • compiles zenoh-c in release mode (without logs)
  • cross-compiles zenoh-c on all supported platforms (incl. MacOS if this is your current host) using dockross.
  • generates the Javadoc
  • generate a ZIP file for release in assembly/target

Examples

See examples/zenoh/README.md