GithubHelp home page GithubHelp logo

veeso / octopipes Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 62 KB

Just an IPC server based on pipes.

License: MIT License

Rust 100.00%
ipc inter-process-communication pipes unix-pipes c cpp14 ipc-server named-pipes octopipes-protocol rust

octopipes's Introduction

Octopipes

License: MIT Stars Issues Build

Just an IPC server based on pipes.

Developed by Christian Visintin

Currently under development (Scheduled release: February 2020)



Introduction

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

How it works

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


Project Tree

  • 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

Octopipes Server

You can find the entire Octopipes Server documentation Here

Octopipes Clients

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 libraries

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

Language Library Requirements Supported Platforms Server/Client Repository
C liboctopipes C compiler (GNU gcc, Clang), CMake GNU Linux, MacOS, Windows (MinGW not yet) Both https://github.com/ChristianVisintin/liboctopipes
C++ liboctopipespp C++ compiler (GNU g++, Clang), CMake GNU Linux, MacOS, Windows (MinGW not yet) Both https://github.com/ChristianVisintin/liboctopipes
Rust rustypipes rustc, cargo GNU Linux, MacOS, Windows Both https://github.com/ChristianVisintin/Rustypipes

Octopipes Protocol

Here You can find the entire Protocol reference.


Know Issues


Upcoming features

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

Contributing

TBD


Changelog


License

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.

octopipes's People

Contributors

veeso avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.