makes multilevel server/client simpler and stronger, with auto restart and reconnect.
npm install multilevel-agentmultilevel-agent  
================
makes multilevel server/client simpler, with auto restart and reconnect.
npm install multilevel-agent
Usage
javascript
var multilevelAgent = require('multilevel-agent');
`$3
javascript
var server = multilevelAgent.Server([options]);
`
The could have below properties:
- location The directory where to storage your data(required).
- autostart A value indicates whether automatic start the SERVER or not, false as default.
- port Port of TCP server, 8081 as default.
- auth and access from multilevel
- options from levelup#### Example
`javascript
var server = multilevelAgent.Server({
location: __dirname + '/db/',
port: 8090,
valueEncoding: 'json',
auth: function (user, cb) {
if (user.name == 'root' && user.pass == 'p@ss') {
cb(null, {name: 'root'});
} else {
cb(new Error('not authorized'));
}
},
access: function (user, db, method, args) {
if (!user || user.name !== 'root') {
if (/^put|^del|^batch|write/i.test(method)) {
throw new Error('read-only access');
}
}
}
});
`
See more from .#### Events
##### error
Emitted when an error occurs, e.g.:
`javascript
server.on('error', function(err){});
`
The is an instance of Error, and in addition, err has one more property err.source, see more from sources.##### connect
Emitted when a new TCP connection is made, e.g.:
`javascript
server.on('connect', function(){});
`##### close
Emitted when the server/client/database closes, e.g.:
javascript
server.on('close', function(agent){});
`
agent including two properties:
- source One of sources.
- event The original event.This event is very important, and you can use
to identify who emitted 'close' event, it could be one of sources. If it is 'tcp_server' or 'database', it means server or database has just crashed, you'd better restart your server. If you are using pm2, just exist the process then pm2 will auto restart your server:
`javascript
server.on('close', function(agent){
if(agent.source == multiAgent.Server.source.TCP_SERVER || agent.source == multiAgent.Server.source.DATABASE){
process.exit(0);
return;
}
// tcp_client closed? screw it.
});
`
#### Methods
##### start
Just start the server, if is set to true, this effects nothing.
`javascript
server.start();
`##### stop
If current
equals multiAgent.Server.state.RUNNING, stops the server.
Notes: The server is finally closed when all connections are ended and the server emits a 'close' event. So, if you really wanna shut down the server, just try process.exit(0).
`javascript
server.stop();
`#### Properties
##### options
The restructuring options.
javascript
console.log(server.options);
`##### state
The current state of server, see more from states.
##### port
The port of TCP server.
$3
javascript
var client = multilevelAgent.Client([options]);
`
The could have below properties:
- host The host of TCP server(required).
- port The port of TCP server which client connects to.
- manifest See [multilevel.client([manifest])](https://github.com/juliangruber/multilevel#var-db--multilevelclientmanifest).#### Example
`javascript
var client = multilevelAgent.Client({
host: 'localhost',
port: 8090
});
`
See more from .#### API
Access multilevel's APIs through
client.db, e.g.:
`javascript
client.db.put('KEY', 'VALUE');
client.db.get('KEY', function(err, value){});
// ...
`#### Events
##### error
Emitted when an error occurs, e.g.:
javascript
server.on('error', function(err){});
`
The is an instance of Error, and in addition, err has one more property err.source, see more from sources.##### connect
Emitted when a new TCP connection or Database is made, e.g.:
`javascript
server.on('connect', function(){});
`##### reconnecting
Emitted when reconnecting to datababase/tcp server, e.g.:
javascript
client.on('reconnecting', function(recon){})
`
The indluding two properties:
- attempts The attempts number that CLIENT has tried reconnect to server.
- delay The next retry delay(milliseconds).#### Properties
##### options
The restructuring options.
`javascript
console.log(server.options);
`##### state
The current state of server, see more from states.
Sources
$3
- 'database' equals .
- 'tcp_client' equals multiAgent.Server.source.TCP_CLIENT.
- 'tcp_server' equals multiAgent.Server.source.TCP_SERVER.
- 'level_server' equals multiAgent.Server.source.LEVEL_SERVER.$3
- 'database' equals multiAgent.Client.source.DATABASE.
- 'tcp_client' equals multiAgent.Client.source.TCP_CLIENT.
- 'rpc_stream' equals multiAgent.Client.source.RPC_STREAM.
- 'level_server' equals multiAgent.Client.source.LEVEL_SERVER.States
$3
- 'init' equals multiAgent.Server.state.INIT.
- 'running' equals multiAgent.Server.state.RUNNING.
- 'stop' equals multiAgent.Server.state.STOP.$3
- 'init' equals multiAgent.Client.state.INIT.
- 'running' equals multiAgent.Client.state.RUNNING.
- 'stop' equals multiAgent.Client.state.STOP.
Test
Only test options.
`
npm test
Manual test:
- First: start server
javascript
node example/server
`- Second: run client
javascript
node example/client
``If you wanna make different tests, just edit the scripts under example folder.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.