node-ipc/params.json

7 lines
29 KiB
JSON
Raw Permalink Normal View History

2016-03-23 18:43:18 +11:00
{
"name": "Node-ipc",
"tagline": "Inter Process Communication Module for node supporting Unix sockets, TCP, TLS, and UDP. Giving lightning speed on Linux, Mac, and Windows. Neural Networking in Node.JS",
"body": "node-ipc\r\n================\r\n*a nodejs module for local and remote Inter Process Communication* with full support for Linux, Mac and Windows. It also supports all forms of socket communication from low level unix and windows sockets to UDP and secure TLS and TCP sockets.\r\n\r\nA great solution for complex multiprocess **Neural Networking** in Node.JS\r\n\r\n**npm install node-ipc**\r\n\r\n#### NPM Stats\r\n\r\nnpm info : [See npm trends and stats for node-ipc](http://npm-stat.com/charts.html?package=node-ipc&author=&from=&to=) \r\n[![NPM](https://nodei.co/npm/node-ipc.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/node-ipc/)\r\n[![Package Quality](http://npm.packagequality.com/badge/node-ipc.png)](http://packagequality.com/#?package=node-ipc) \r\n![node-ipc npm version](https://img.shields.io/npm/v/node-ipc.svg) ![supported node version for node-ipc](https://img.shields.io/node/v/node-ipc.svg) ![total npm downloads for node-ipc](https://img.shields.io/npm/dt/node-ipc.svg) ![monthly npm downloads for node-ipc](https://img.shields.io/npm/dm/node-ipc.svg) ![npm licence for node-ipc](https://img.shields.io/npm/l/node-ipc.svg)\r\n\r\n[![RIAEvangelist](https://avatars3.githubusercontent.com/u/369041?v=3&s=100)](https://github.com/RIAEvangelist)\r\n\r\nGitHub info : \r\n![node-ipc GitHub Release](https://img.shields.io/github/release/RIAEvangelist/node-ipc.svg) ![GitHub license node-ipc license](https://img.shields.io/github/license/RIAEvangelist/node-ipc.svg) ![open issues for node-ipc on GitHub](https://img.shields.io/github/issues/RIAEvangelist/node-ipc.svg)\r\n\r\nCodacy info : \r\n[![Codacy Badge](https://api.codacy.com/project/badge/grade/8e0294dff55f4ac1985c07b16f39d0a9)](https://www.codacy.com/app/RIAEvangelist/node-ipc) [![Codacy Badge](https://api.codacy.com/project/badge/coverage/8e0294dff55f4ac1985c07b16f39d0a9)](https://www.codacy.com/app/RIAEvangelist/node-ipc)\r\n\r\nPackage details websites :\r\n* [GitHub.io site](http://riaevangelist.github.io/node-ipc/ \"node-ipc documentation\"). A prettier version of this site.\r\n* [NPM Module](https://www.npmjs.org/package/node-ipc \"node-ipc npm module\"). The npm page for the node-ipc module.\r\n\r\nThis work is licenced via the [DBAD Public Licence](http://www.dbad-license.org/).\r\n\r\n#### Testing\r\n\r\n` npm test ` will run the jasmine tests with istanbul for node-ipc and generate a coverage report in the spec folder.\r\n\r\nYou may want to install jasmine and istanbul globally with ` sudo npm install -g jasmine istanbul `\r\n\r\n----\r\n#### Contents\r\n\r\n1. [Types of IPC Sockets and Supporting OS](#types-of-ipc-sockets)\r\n1. [IPC Config](#ipc-config)\r\n2. [IPC Methods](#ipc-methods)\r\n 1. [log](#log)\r\n 2. [connectTo](#connectto)\r\n 3. [connectToNet](#connecttonet)\r\n 4. [disconnect](#disconnect)\r\n 5. [serve](#serve)\r\n 6. [serveNet](#servenet)\r\n3. [IPC Stores and Default Variables](#ipc-stores-and-default-variables)\r\n4. [IPC Events](#ipc-events)\r\n5. [Multiple IPC instances](#multiple-ipc-instances)\r\n6. [Basic Examples](#basic-examples)\r\n 1. [Server for Unix||Windows Sockets & TCP Sockets](#server-for-unix-sockets--tcp-sockets)\r\n 2. [Client for Unix||Windows Sockets & TCP Sockets](#client-for-unix-sockets--tcp-sockets)\r\n 4. [Server & Client for UDP Sockets](#server--client-for-udp-sockets)\r\n 5. [Raw Buffers, Real Time and / or Binary Sockets](#raw-buffer-or-binary-sockets)\r\n7. [Working with TLS/SSL Socket Servers & Clients](https://github.com/RIAEvangelist/node-ipc/tree/master/example/TLSSocket)\r\n8. [Node Code Examples](https://github.com/RIAEvangelist/node-ipc/tree/master/example)\r\n\r\n\r\n----\r\n#### Types of IPC Sockets\r\n\r\n| Type | Stability |Definition |\r\n|-----------|-----------|-----------|\r\n|Unix Socket or Windows Socket| Stable | Gives Linux, Mac, and Windows lightning fast communication and avoids the network card to reduce overhead and latency. [Local Unix and Windows Socket examples ](https://github.com/RIAEvangelist/node-ipc/tre
"google": "UA-48524110-1",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}