unix sockets on nodeJs

Question

Quick and basic nodeJs question, I'm working with unix socket for inter-server communication between c++ application and my NodeJs server,

I've wrote my nodeJs server like so:

var net = require('net');
var unixSocketServer = net.createConnection('/tmp/unixSocket');
unixSocketServer.on('connect',function(){
    console.log('unix server socket connected on /tmp/unixSocket');
    ...
});

However I'm getting connection refuse error. I can understand that the c++ application haven't opened/connected to the socket yet. My questions are why does it matter? shouldn't the nodeJs server wait until 'connect' event emitted? Am I using nodeJs currently? am I missing something?

Are you trying to start a server on a unix socket or connect to an existing unix socket? If the latter, did you check permissions on /tmp/unixSocket? If the former, you should use net.createServer() instead. — mscdex
– mscdex, Commented Jan 5, 2015 at 16:37
I'm having some trouble figuring this out, My usecase is that the c++ application internal state can be changed by the user via nodeJs. should this NodeJs be a server or a client? — CodeHahn
– CodeHahn, Commented Jan 5, 2015 at 16:55
My unix socket was previously declared, I've removed it with: fs.unlink(socketpath). — CodeHahn
– CodeHahn, Commented Jan 7, 2015 at 12:46

Avery · Accepted Answer · 2018-01-14 17:59:09Z

13

Ok, so there's some misunderstanding here. Let's start from what a 'unix socket' really is. I think you're thinking it's just a file-like item that acts like a server on its own through the OS/filesystem. That's not quite correct. While it is indeed bound through the filesystem, it isn't really a traditional file. Instead, it's just like an TCP/IP socket, except instead of binding an IP and port, a filepath is bound.

The key point there is that it's just a bound socket with a different type of address (and some extra capabilities, but that's outside the scope here). So that means that something has to bind the socket! In this case, we need a server, just like we would if we were communicating over a 'normal' port. If there isn't a server bound to the path, you get an error, just like you would when connecting to a port with no listener.

To create a server on a unix domain socket in node, it's pretty simple:

'use strict';

const net = require('net');
const unixSocketServer = net.createServer();

unixSocketServer.listen('/tmp/unixSocket', () => {
  console.log('now listening');
});

unixSocketServer.on('connection', (s) => {
  console.log('got connection!');
  s.write('hello world');
  s.end();
});

Note that there is one other difference between 'normal' sockets and unix domain sockets: After a server is done with the unix domain socket, it is not automatically destroyed. You must instead unlink /tmp/unixSocket in order to reuse that 'address'/path

answered Jan 14, 2018 at 17:59

Avery

2,3034 gold badges33 silver badges35 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Joakim L. Christiansen Over a year ago

How do you unlink the socket? There is no information on how to do it in the docs. EDIT: Ah, by deleting the file. fs.unlinkSync(ipcPath)

Avery Over a year ago

@JoakimL.Christiansen, yeap, fs.unlinkSync() is one way to do it. On systems that support unix sockets, the unlink command I referenced in the post exists and is another way.

Collectives™ on Stack Overflow

unix sockets on nodeJs

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related