ulwanski / unix-dgram-socket Goto Github PK

Node implementation of unix datagram socket writed in TypeScript

License: GNU General Public License v3.0

JavaScript 0.85% Python 0.61% C++ 27.86% TypeScript 70.68%

node dgram unix-socket ipc socket nodejs nodejs-modules nodejs-socket

unix-dgram-socket's Introduction

unix-dgram-socket

Connection-less, reliable unix datagram socket implementation with abstract namespace support for local interprocess communication in Node.JS application. UNIX domain sockets can be either unnamed, or bound to a filesystem pathname (marked as being of type socket). Linux also supports an abstract namespace which is independent of the filesystem.

Installation

npm i unix-dgram-socket --save

Package C++ addons will be compiled during installation.

Examples

Open socket

import {UnixDgramSocket} from "unix-dgram-socket";

const socket = new UnixDgramSocket();

// Call on error
socket.on('error', (error: any) => {
    console.log(error);
});

// Call when new message is received
socket.on('message', (message: Buffer, info: any) => {
    console.log(message.toString(UnixDgramSocket.payloadEncoding));
    console.log(info);
});

// Call when socket is bind to path
socket.on('listening', (path: string) => {
    console.log(`socket listening on path: ${path}`);
});

// Bind socket to filesystem path
socket.bind("/tmp/socket1.sock");

Sending messages

import {UnixDgramSocket} from "unix-dgram-socket";

const socket = new UnixDgramSocket();

// Call on error
socket.on('error', (error: any) => {
    console.log(error);
});

// Call when new message is received
socket.on('message', (message: Buffer, info: any) => {
    console.log(message.toString(UnixDgramSocket.payloadEncoding));
    console.log(info);
});

// Call on successful connect
socket.on('connect', (path: string) => {
    console.log(`socket connected to path: ${path}`);
});

// Call when socket is bind to path
socket.on('listening', (path: string) => {
    console.log(`socket listening on path: ${path}`);
});

socket.send("Special inter-process delivery!", "/tmp/socket1.sock");

// Dgram socket is connection-less so call connect only set default destination path and can be called many times
socket.connect("/tmp/socket1.sock");

// Send can be called without path if 'connect' was called before
socket.send("I will be send to default path, set by connect!");

// CLose socket to prevent further communication
socket.close();

Operating with abstract namespace path

Abstract namespace path can be passed by starting path string from null byte ('\0') or "@" character.

// Bind socket to abstract path
socket.bind("@/abstract/path/socket1.sock");

// Send data to abstract namespace path
socket.send("Special inter-process delivery!", "@/abstract/path/socket1.sock");

Additional information

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GPL-3.0

References

unix-dgram-socket's People

Contributors

Stargazers

Watchers

Forkers

redneb refracta mashua

unix-dgram-socket's Issues

A full length abstract socket the last byte is \0

https://github.com/ulwanski/unix-dgram-socket/blob/master/src/unix_dgram.cc#L198

When copying the path it should actually be min( length(path), sizeof(s.sun_path) ) or 108.

I have an abstract socket that has 108 bytes in the name used up and the last characted gets overwritten with \0 because of strncpy(s.sun_path, *path, sizeof(s.sun_path) - 1);

Build error - Node v12?

Trying to install this module from NPM, I get a bunch of compile errors, eg.:
../src/unix_dgram.cc:358:28: error: no matching function for call to ‘v8::Value::Int32Value()’

../src/unix_dgram.cc:429:63: error: no matching function for call to ‘v8::FunctionTemplate::GetFunction()’

My knowledge on Nan is limited, but it must be related to V8 deprecating a lot of API calls.

I think the similar library node-unix-dgram got most of it covered in this commit:
bnoordhuis/node-unix-dgram@0ae2a61#diff-8e3ec9d4b59eaf953bbd7fe258cb5700

And this leads to the following problem.

let connectionInfo = {};
socket.on('message', (message, info) => {
    let path = info.remoteSocket;
    if (!connectionInfo[info.remoteSocket]) {
        connectionInfo[info.remoteSocket] = { path };
    }
    let currentInfo = connectionInfo[path];
    currentInfo.id = setInterval(_ => {
        socket.send(data, info.remoteSocket);
    }, 1000);
});

socket.on('error', (error) => {
	// can't stop setInterval callback
});

I suggest two ways.

Improvement 1 (socket.send throw error)

let connectionInfo = {};
socket.on('message', (message, info) => {
    let path = info.remoteSocket;
    if (!connectionInfo[info.remoteSocket]) {
        connectionInfo[info.remoteSocket] = { path };
    }
    let currentInfo = connectionInfo[path];
    currentInfo.id = setInterval(_ => {
        try {
            socket.send(data, info.remoteSocket);
        } catch (e) {
            clearInterval(currentInfo.id);
        }
    }, 1000);
});

Improvement 2 (return error object with remoteSocket)

socket.on('error', (error) => {
	if(error.syscall == 'send'){
		clearInterval(connectionInfo[error.remoteSocket].id);
	}
});