https://github.com/streamich/socket.io-reqres
Request/response for socket.io
https://github.com/streamich/socket.io-reqres
Last synced: 8 months ago
JSON representation
Request/response for socket.io
- Host: GitHub
- URL: https://github.com/streamich/socket.io-reqres
- Owner: streamich
- Created: 2014-11-19T13:13:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-01-05T09:30:16.000Z (over 8 years ago)
- Last Synced: 2025-07-14T07:17:55.772Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.93 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Request/response for socket.io
Emulates request/response pattern in socket.io. You can also choose to make your Node.js app a client, and make browser a server.
On "client" side:
```js
var Client = require("socket.io-reqres").Client;
var client = new Client;
// Where `socket` is socket.io socket object.
client.setSocket(socket);
client.request("myMethod", "Hello", function(err, response) {
console.log(err, response);
});
```
On "server" side:
```js
var Server = require("socket.io-reqres").Server;
var server = new Server;
server.use("myMethod", function(data, send) {
send(data + " world");
});
// Where `socket` is socket.io socket object.
server.setSocket(socket);
```
## API
- `new Server(name)` - optional server name, defaults to `""`.
- `Server.setSocket(socket)` - set socket.io socket object.
- `Server.use(method, callback)` - register RPC method.
- `new Client(name, timeout)` - optional server name, defaults to `""`. Optional timeout in ms.
- `Client.setSocket(socket)` - set socket.io socket object.
- `Client.request(method, data, callback)` - send request to the server.