Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.42 KB

README.md

File metadata and controls

44 lines (34 loc) · 1.42 KB
Raw

libArcus is a lightweight, easy to use library to send and receive messages between two programs based on the Protocol Buffers library by Google. It was originally developed by Ultimaker and is primarily used to communicate with their CuraEngine. This is a port of the original library to the programming language Java. The API is almost identical to make working with both libraries more easy.

Usage

// Create a new instance
ArcusSocket socket = new ArcusSocket();

// Add a listener
socket.addListener(...);

// Register a message type
socket.registerMessageType(MyType.getDefaultInstanceForType());

// Start listening on the specified port
socket.listen(...);

// Send a message
socket.sendMessage(...);

// Retrieve a received message
Message message = socket.takeNextMessage();

// Check of message type
if (message != null && message instanceof MyType) {
    doStuff((MyType) message);
}

// Close the connection
socket.close();

Maven

libArcus-Java has been published on Maven Central and you can add it to your pom.xml as a dependency.

<dependency>
  <groupId>de.ocarthon</groupId>
  <artifactId>libArcus</artifactId>
  <version>1.0.2</version>
</dependency>

More detailed information on how the library works and how to use it can be found in the Documentation