childprocess-vertx-ext

childprocess-vertx-ext copied to clipboard

Child Process extension for Vert.x

Spawn child processes from Vert.x.

Based on https://github.com/brettwooldridge/NuProcess Low-overhead, non-blocking I/O, external Process implementation for Java.

What for ?

Vert.x 3.6.2

Using Child Process

To use Child Process, add the following dependency to the dependencies section of your build descriptor:

• Maven (in your pom.xml):

<dependency>
  <groupId>com.julienviet</groupId>
  <artifactId>childprocess-vertx-ext</artifactId>
  <version>1.3.0</version>
</dependency>

• Gradle (in your build.gradle file):

dependencies {
  compile 'com.julienviet:childprocess-vertx-ext:1.3.0'
}

Spawn child processes from Vert.x:

Process.create(vertx, "cat").spawn(process -> {
  process.stdout().handler(buf -> {
    System.out.println("Process wrote: " + buf);
  });
  StreamOutput stdin = process.stdin();
  stdin.write(Buffer.buffer("hello"));
  stdin.close();
  process.exitHandler(code -> {
    System.out.println("Process exited: " + code);
  });
});

Web-site docs

• Java docs
• Kotlin docs
• Groovy docs
• Ruby docs
• JavaScript docs

Previous Vert.x versions

• Vert.x 3.5.x : use 1.2.2
• Vert.x 3.4.x : use 1.1.2

Snapshots

Use the dependency

<dependency>
  <groupId>com.julienviet</groupId>
  <artifactId>childprocess-vertx-ext</artifactId>
  <version>1.3.1-SNAPSHOT</version>
</dependency>

Snapshots are deploy in Sonatype OSS repository: https://oss.sonatype.org/content/repositories/snapshots/com/julienviet/childprocess-vertx-ext/

License

Apache License - Version 2.0

Documentation

The online and published documentation is in /docs and is served by GitHub pages with Jekyll.

You can find the actual guide source in src/main/docs/index.md. At compilation time, this source generates the jekyll/guide/java/index.md.

The current documentation is in /jekyll and can be preview using Docker and your browser

• generate the documentation ** mvn compile to generate jekyll/guide/java/index.md ** mvn site to generate the javadoc in jekyll/apidocs
• run Jekyll ** cd jekyll ** docker-compose up
• open your browser at http://localhost:4000