# ipc-protocol

> Provides a simple IPC over TCP

Latest version **1.0.8** (published 2020-01-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install ipc-protocol
pnpm add ipc-protocol
yarn add ipc-protocol
bun add ipc-protocol
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2020-01-30 |
| First published | 2019-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Muratura43 |
| Maintainers | muratura43 |
| Keywords | ipc, protocol, tcp, net, muratura |

## Links

- npm: https://www.npmjs.com/package/ipc-protocol
- Repository: https://github.com/Muratura43/ipc-protocol
- Homepage: https://github.com/Muratura43/ipc-protocol#readme
- Issues: https://github.com/Muratura43/ipc-protocol/issues
- npm.io page: https://npm.io/package/ipc-protocol

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^3.3.3

## Recent versions

- 1.0.8 (latest) — 2020-01-30
- 1.0.7 — 2020-01-17
- 1.0.6 — 2020-01-16
- 1.0.5 — 2019-10-22
- 1.0.4 — 2019-09-29
- 1.0.3 — 2019-09-27
- 1.0.2 — 2019-09-04
- 1.0.1 — 2019-09-02
- 1.0.0 — 2019-09-02

## README

# ipc-protocol
Provides simple interprocess communication, through TCP.

## Installation
Using npm:
```
npm install ipc-protocol
```

In Node.js:
```
// Import the ipc-protocol and return an instance of the client/server
const ipcProtocol = require('ipc-protocol').getIpc(constants.clientPort, constants.serverPort, '127.0.0.1');

// A send example:
ipcProtocol.send({
    Command: 'command',
    Payload: null
}, (err) => {
    console.error(err);
});

// A listen example:
main.listen((a, head) => {
    console.log('Received: ' + a);

    // Sending a callback with the same headers
    main.send({
        Command: 'node-callback',
        Payload: null
    }, (err) => {
        console.error(err);
    }, head)
});
```

## Note:
This solution integrates perfectly with the .NET Core solution [IpcProtocol.Core](https://github.com/Muratura43/IpcProtocol.Core)

---
_Source: https://npm.io/package/ipc-protocol · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._