ipc

Casterlabs Commons/IPC

In progress :^)

Protocol

All actual messaging is done over JSON, this is for interoperability and ease-of-debugging (with the exception being Throwables, which use Java's built-in [de]serialization). Passing non-ipc objects is accomplished by serializing them using Rson, where you will need to add either @JsonField or @JsonClass(exposeAll = true) to your fields or classes respectively.

Examples

Using your own communication:

public class Example {
    private static IpcConnection client;
    private static IpcConnection host;

    public static void main(String[] args) throws InterruptedException {
        client = new IpcConnection() {
            @Override
            protected void handleMessage(Object message) {
                TestObject test = (TestObject) message;

                System.out.printf("Answer to life, the universe, and everything: %d\n", test.answer(21));
            }

            @Override
            protected void send(IpcPacket packet) {
                System.out.printf("[Client] Send: %s\n", Rson.DEFAULT.toJsonString(packet));
                AsyncTask.createNonDaemon(() -> host.receive(packet));
            }
        };

        host = new IpcConnection() {
            @Override
            protected void handleMessage(Object message) {
                // Unused
            }

            @Override
            protected void send(IpcPacket packet) {
                System.out.printf("[Host  ] Send: %s\n", Rson.DEFAULT.toJsonString(packet));
                AsyncTask.createNonDaemon(() -> client.receive(packet));
            }
        };

        TestObject localInstance = new TestObject();

        host.sendMessage(localInstance);

        Thread.sleep(100000); // Sleep indefinitely. Prevents GC.
    }

    public static class TestObject extends IpcObject {

        public int answer(int base) {
            return base * 2;
        }

    }

}

Spawning another Java process and communicating with it:

public class Test {

    public static void main(String[] args) throws Exception {
        TestHost test = new TestHost();
    }

    public static class TestClient extends SubprocessIpcClientHandler {

        public TestClient() {
            this.sendMessage("Hello host!");
            this.sendByteMessage(2, "To: World\nFrom: Client\n\nHello!".getBytes());
        }

        @Override
        public void handleMessage(Object message) {
            System.out.printf("Message from host:   %s\n", message);
        }

    }

    public static class TestHost extends SubprocessIpcHostHandler {

        public TestHost() throws IOException {
            super(TestClient.class);
            this.sendMessage("Hello client!");
        }

        @Override
        public void handleMessage(Object message) {
            System.out.printf("Message from client: %s\n", message);
        }

        @Override
        public void handleByteMessage(int type, byte[] message) {
            System.out.printf(
                    "Byte message from client: (type: %d) %s\n",
                    type,
                    Base64.getEncoder().encodeToString(message)
            );
        }

        @Override
        public void onClose() {
            System.out.println("Client closed");
        }

    }

}

Adding to your project

Replace VERSION_OR_HASH with the latest version or commit in this repo and make sure to add the Repository to your build system.

Maven

  <dependency>
      <groupId>co.casterlabs.commons</groupId>
      <artifactId>IPC</artifactId>
      <version>VERSION_OR_HASH</version>
  </dependency>

Gradle

  dependencies {
      implementation 'co.casterlabs.commons:IPC:VERSION_OR_HASH'
  }

SBT

libraryDependencies += "co.casterlabs.commons" % "IPC" % "VERSION_OR_HASH"

Leiningen

:dependencies [[co.casterlabs.commons/IPC "VERSION_OR_HASH"]]