Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cap32/create-local-domain-socket
A helper function to create cross-platform local domain sockets
https://github.com/cap32/create-local-domain-socket
cross-platform helper ipc named-pipes socket unix unix-domain-socket windows
Last synced: about 1 month ago
JSON representation
A helper function to create cross-platform local domain sockets
- Host: GitHub
- URL: https://github.com/cap32/create-local-domain-socket
- Owner: Cap32
- License: mit
- Created: 2017-11-04T16:04:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-23T13:42:07.000Z (over 6 years ago)
- Last Synced: 2024-11-13T10:52:56.269Z (about 2 months ago)
- Topics: cross-platform, helper, ipc, named-pipes, socket, unix, unix-domain-socket, windows
- Language: JavaScript
- Size: 56.6 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# create-local-domain-socket
[](https://travis-ci.org/Cap32/create-local-domain-socket)
[](https://ci.appveyor.com/project/Cap32/create-local-domain-socket/branch/master)
[](https://coveralls.io/github/Cap32/create-local-domain-socket?branch=master)
[](https://badge.fury.io/js/create-local-domain-socket)
[](https://github.com/Cap32/create-local-domain-socket/blob/master/LICENSE.md)
A helper function to create cross-platform local domain sockets (UNIX domain sockets on UNIX, and named pipes polyfill on Windows).
## Usage
### createLocalDomainSocket
```js
import createLocalDomainSocket from 'create-local-domain-socket';
import http from 'http';
/* create a whatever you want server */
const server = http.createServer((req, res) => {
const body = http.STATUS_CODES[426];
res.writeHead(426, {
'Content-Length': body.length,
'Content-Type': 'text/plain'
});
res.end(body);
});
createLocalDomainSocket(server, '/tmp/test.sock', (err) => {
if (err) { console.error(err); }
else { console.log('socket server started'); }
});
```
If you prefer using promise:
```js
const server = http.createServer();
createLocalDomainSocket(server, '/tmp/test.sock')
.then(() => console.log('socket server started'))
.catch((err) => console.error(err))
;
```
#### Arguments
1. `server` \: A server object. Should include a `.listen()` and `.on('error')` methods to start and catch errors
2. `path` \: Local domain path
3. `callback` \ (Optional): A callback function. The first argument is an `Error` object if listen failed. If `callback` is `undefined`, it will return a promise
### ensureLocalDomainPath
A tiny helper function to ensure local domain path. On Windows, it will convert to named pipe path instead of local domain path.
#### Example on Windows
```js
import { ensureLocalDomainPath } from 'create-local-domain-socket';
const path = ensureLocalDomainPath('/test');
console.log(path); /* "\\\\.\\pipe\\test" */
```
## Installation
```bash
npm install --save create-local-domain-socket
```
## Example to integrate with [ws](https://github.com/websockets/ws)
```js
import WebSocket from 'ws';
import createLocalDomainSocket from 'createLocalDomainSocket';
import http from 'http';
const server = http.createServer((req, res) => {
const body = http.STATUS_CODES[426];
res.writeHead(426, {
'Content-Length': body.length,
'Content-Type': 'text/plain'
});
res.end(body);
});
createLocalDomainSocket(server, path, (err) => {
if (err) { done.fail(err); }
else {
const wss = new WebSocket.Server({ server });
const ws = new WebSocket(`ws+unix://${path}`);
ws.on('message', (message) => {
/* do sth... */
});
wss.on('connection', (client) => {
client.send('sth');
});
}
});
```
## License
MIT