Difference between socket.join and io.adapter.remoteJoin?

[robinclark]

I'm not sure I'm understanding the differences. Would someone mind clarifying?

[darrachequesne]

@robinclark remoteJoin allow you to make a given socket join a room from another node.

Sample use-case: #125 (comment)

[darrachequesne]

Do you have any suggestion to make the documentation clearer? Help is welcome!

[robinclark]

I think my socket.io knowledge was just a bit lacking. I assumed that joining rooms normally across nodes would have worked without special handling. Nice addition!

[knoxcard]

Here is a good question...do we need to run both socket.join() and socket.remoteJoin()?? or just socket.remoteJoin()?

[rodrigoreis22]

@knoxcard i have the same question, not sure if we should call both .join() and remotejoin().

[darrachequesne]

socket.join() is when you have access to the socket object:

io.on('connect', socket => {
  socket.join('room1');
  
  socket.on('test', () => {
    socket.join('room2');
  });
});

adapter.remoteJoin() is when you don't have access to the socket object (in a multi server setup, for example):

io.of('/').adapter.remoteJoin(socketId, 'room1');