Create a instance of Socket.IO Server.
A port must be specified to bind.
JSON is required for options. Options information can be referenced in Socket.IO documentation.
Specify an instance to listen for specific event.
A Socket instance will be mounted to msg.socket for output.
For example, you can listen for connection event, and when a client connects, you can identify it by handshake from msg.socket.handshake.
Send data for a specific event to clients.
Mount data for sending to msg.payload.
msg.event, msg.namespace, msg.room can be used to override node's options.
Let Socket instance join or leave a specific room.
Socket instance must be mounted to msg.socket.
Same msg will be output.
msg.room can be used to override node's options.
Middleware settings for Socket.IO Server instance.
Need to be used with socket.io middleware end.
The middleware process that needs to be handled is connected in series between socket.io middleware start and socket.io middleware end.
The process will receive an input that contains msg.socket and msg.next.
msg.socket: Socket instance.
msg.next: Middleware process completion method.
NOTE: Do not override or delete these two members in the process.
The process finally needs to mount true / false to msg.payload, Then link to socket.io middleware end to complete the entire process of the middleware.
success: socket.io middleware end receives msg.payload what is true.
fail: socket.io middleware end receives msg.payload is false, the client will be disconnected. You can mount a custom error message to msg.errMsg which will be send to client.
You can find example flow here.
A chat demo is available:
- Import the chat demo flow to your node-red.
- Open two tabs with this demo page on your browser.
- Enter the address of the socket.io in node-red, your name and your friend's name (just imaginary names like Tom and Jerry😀).
- Swap names on another tab, don't forget the address.
- Try it.
