npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

unix-dgram-socket

v1.1.1

Published

Unix datagram socket with abstract namespace support for local interprocess communication.

Downloads

996

Readme

unix-dgram-socket

Node.js CI

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.

Maintainability Test Coverage Codacy Badge

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

  • http://man7.org/linux/man-pages/man7/unix.7.html
  • http://man7.org/linux/man-pages/man2/socket.2.html