Just an IPC server based on pipes.

Developed by Christian Visintin

Currently under development (Scheduled release: February 2020)

• Octopipes
  • Introduction
    • How it works
  • Project Tree
  • Octopipes Server
  • Octopipes Clients
  • Octopipes libraries
  • Octopipes Protocol
  • Know Issues
  • Upcoming features
  • Contributing
  • Changelog
  • License

Octopipes is a server application which improves and organize the good old named pipes to implement and handle Inter Process Communication (IPC). Octopipes uses named pipes (or FIFO) to exchange data between hosts. Each process subscribes to the Octopipes server with its own ID and optionally with a group ID and then the server assigns to it a pipe to use to communicate with other processes. The messages must be sent using the Octopipe protocol as defined.

These are the main features Octopipes provides:

• Fast and reliable IPC
• Message exchanging between individual processes and groups
• Free data format

Before talking of the working flow of Octopipes let's introduce what Octopipes is. Octopipes is, indeed, an IPC server which takes care of:

• Listening for incoming client subscription requests.
• Assigning to each client two named pipes, one for transmission and one for reception.
• Listening on client TX pipe and dispatch the messages to their recipients through their RX pipe.

Octopipes working flow is pretty much simple and consists of a 4 steps lifecycle.

1. Subscription
2. Assignment
3. IPC
4. Unsubscription

Each client can subscribe to groups or other clients for receiving messages associated to that node. The client, once subscribed, receives a pipes where to listen for incoming messages and one where to transmit to other clients.

The entire protocol ruleset/workflow/reference can be found here

• root
  • docs: Octopipes documentation pages
  • octopipes-clients: Test clients to quickly send to and listen for messages from your octopipes server
  • octopipes-server: contains the Octopipes Server

You can find the entire Octopipes Server documentation Here

Octopipes comes with two clients, one to send and one to receive messages. The clients are provided both with liboctopipes and with the cargo crate octopipes-clients.

For more details:

• octopipes-clients

Here follows a list of all the available libraries to implement Octopipes clients and servers

Here You can find the entire Protocol reference.

• Windows support
• OctoNetworks (IPC between multiple Octopipes hosts)
• New CAP messages:
  • Get clients

TBD

MIT License

Copyright (c) 2019-2020 Christian Visintin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.