# net-request-response
> It implements request-response model for net.socket.
Latest version **0.0.14** (published 2015-07-06) · 0 weekly downloads
## Install
```sh
npm install net-request-response
pnpm add net-request-response
yarn add net-request-response
bun add net-request-response
```
## Health
**Score 10/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.14 |
| Published | 2015-07-06 |
| First published | 2015-07-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Allen Show |
| Maintainers | allenshow |
## Links
- npm: https://www.npmjs.com/package/net-request-response
- Repository: https://github.com/xiulunlin/net-request-response
- Homepage: https://github.com/xiulunlin/net-request-response#readme
- Issues: https://github.com/xiulunlin/net-request-response/issues
- npm.io page: https://npm.io/package/net-request-response
## Recent versions
- 0.0.14 (latest) — 2015-07-06
- 0.0.13 — 2015-07-05
- 0.0.12 — 2015-07-05
- 0.0.11 — 2015-07-05
- 0.0.10 — 2015-07-05
- 0.0.9 — 2015-07-05
- 0.0.8 — 2015-07-05
- 0.0.7 — 2015-07-05
- 0.0.6 — 2015-07-05
- 0.0.5 — 2015-07-05
- 0.0.4 — 2015-07-05
- 0.0.3 — 2015-07-05
- 0.0.2 — 2015-07-05
- 0.0.1 — 2015-07-05
## README
# Net-Request-Response
It is a node module implements request-response model with for net.socket to make communication quicker and easier. It uses a custom protocol.
### How to install
`npm install net-request-response`
## Quick Start
var nrr = require('../index');
//server
var server = nrr.createServer();
server.on('clientConnected', function (client) {
client.on('onRequest', function (payload, response){
console.log('Message from client: '+payload.toString());
//response
response('Okay, I am server.');
});
});
server.listen(8080);
//client
var client =new nrr.Client();
client.connect(8080);
client.on('connect', function () {
//send a string or buffer
this.send('Hello, I am client.', function (error, responsePayload){
if (error) {
console.log(error);
return;
}
console.log('Response from server: '+responsePayload.toString());
});
})
## API
### Net-Request-Reponse Methods
#### createServer(options)
`options` see nodejs document [net.createServer](https://nodejs.org/api/all.html#all_net_createserver_options_connectionlistener).
`callback` is not supported, use `clientConnected` event instead.
#### createClient(options)
`options` see nodejs document [net.createConnection](https://nodejs.org/api/all.html#all_net_createconnection_options_connectionlistener).
`callback` is not supported, use `connect` event instead.
#### Client
`new nrr.Client()` can also be used to create a new client and then you can invoke `client.connect()` to connect lately
### Server Events
`server` will emit some events about the state of qtpServer
#### 'ready'
`server` will emit `ready` event once the `server` is listening correctly
server.on('ready',function(){
console.log(this.address())
});
#### 'clientConnected'
`server` will emit `clientConnected` event if a client is connected to this server. A `client` object will be passed as an argument
server.on('clientConnected',function(client){
//handler client here
});
#### 'error'
`server` will emit `error` event when an error was caught. An `error` object will be passed as an argument
#### 'close'
Fired when `server` is closed and stopped from listening
### Server Methods
#### listen(options)
`options` see nodejs document [net.Server.listen](https://nodejs.org/api/all.html#all_server_listen_port_host_backlog_callback). `Callback` is not supported, use 'ready' event instead.
#### close()
See nodejs document [net.Server.close](https://nodejs.org/api/all.html#all_server_close_callback).
#### address()
Return an address object
### Client Events
`client` will emit some events when a request or response was handled
####'onRequest'
`client` will emit `onRequest` event when it receives request from another side of socket with arguments `payload` and `reponse`:
* `payload`. Buffer.
* `response`. A function to call if you want to response this request.
client.on('onRequest',function(payload,response){
console.log(payload);
//response with a buffer or string
response('message received');
});
#### 'data'
raw tcp data will be passed to `data` event
client.on('data',function(data){
//raw tcp data, including header
console.log(data);
});
#### 'error'
`client` will emit `error` event when an error was caught. An `error` object will be passed as an argument
#### 'close'
fired when `client` is closed
### Client Methods
#### send(payload,onResponse)
A request can be sent either on server side or client side
* `payload`. Buffer or String to be sent.
* `onResponse`. Function, it get invoked with arguments `error` and `payload` if a response is received.
client.send('Hello',function(error,payload){
//get response
if(error){
console.log(error);
return;
}
//payload is buffer
console.log(payload);
});
#### close()
## Message Format
* `type`: qtp use the first `1` bit to mark `request` and `response`: 0 for request and 1 for response
* `sequenceNumber`: the next `15` bits is `sequenceNumber` which is used to distinguish different messages, it is automatically increased by 1 everytime and it will be reset to 0 if it reaches 32768
* `remainingLength`: It stands for the length of message body and it is extendible. The first `1` bit of every byte is to mark the end of header (when the bit is 0)
`00000101` means length 5
`10000001 00000010` means length 129 (1*2^7 + 2)
* `payload`: Message body
---
_Source: https://npm.io/package/net-request-response · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._