## Modules
- binrpc
- client
- protocol
- server
## Classes
- Client
- Protocol
- Server
## binrpc
* [binrpc](#module_binrpc)
* [.createClient(options)](#module_binrpc.createClient) ⇒ [Client](#Client)
* [.createServer(options, onListening)](#module_binrpc.createServer) ⇒ [Server](#Server)
### binrpc.createClient(options) ⇒ [Client](#Client)
RPC client factory
**Kind**: static method of [binrpc](#module_binrpc)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| options | object | | |
| options.host | string | | the hostname or ip address to connect to |
| options.port | number | | the port to connect to |
| [options.reconnectTimeout] | number | 2500 | wait milliseconds until trying to reconnect after the socket was closed |
| [options.responseTimeout] | number | 5000 | wait milliseconds for method call response |
| [options.queueMaxLength] | number | 15 | maximum number of methodCalls that are allowed in the queue |
### binrpc.createServer(options, onListening) ⇒ [Server](#Server)
RPC server factory
**Kind**: static method of [binrpc](#module_binrpc)
| Param | Type | Description |
| --- | --- | --- |
| options | object | |
| options.host | string | ip address on which the server should listen |
| options.port | number | port on which the server should listen |
| onListening | function | function to be invoked in the server's `listening` callback |
## client
* [client](#module_client)
* [.queue](#module_client+queue) : Array
* [.queueMaxLength](#module_client+queueMaxLength) : number
* [.queueRetryTimeout](#module_client+queueRetryTimeout) : number
* [.pending](#module_client+pending) : boolean
* [.responseTimeout](#module_client+responseTimeout) : number
* [.connect()](#module_client+connect)
* [.queuePush(buf, cb)](#module_client+queuePush)
* [.queueShift()](#module_client+queueShift)
* [.methodCall(method, params, callback)](#module_client+methodCall)
### client.queue : Array
The request queue. Array elements must be objects with the properties buffer and callback
**Kind**: instance property of [client](#module_client)
### client.queueMaxLength : number
Maximum queue length. If queue length is greater than this a methodCall will return error 'You are sending too fast'
**Kind**: instance property of [client](#module_client)
### client.queueRetryTimeout : number
Time in milliseconds. How long to wait for retry if a request is pending
**Kind**: instance property of [client](#module_client)
### client.pending : boolean
Indicates if there is a request waiting for its response
**Kind**: instance property of [client](#module_client)
### client.responseTimeout : number
Time in milliseconds. How long to wait for a method call response
**Kind**: instance property of [client](#module_client)
### client.connect()
connect
**Kind**: instance method of [client](#module_client)
### client.queuePush(buf, cb)
Push request to the queue
**Kind**: instance method of [client](#module_client)
| Param | Type |
| --- | --- |
| buf | buffer |
| cb | function |
### client.queueShift()
Shift request from the queue and write it to the socket.
**Kind**: instance method of [client](#module_client)
### client.methodCall(method, params, callback)
methodCall
**Kind**: instance method of [client](#module_client)
| Param | Type | Description |
| --- | --- | --- |
| method | string | |
| params | Array | |
| callback | function | optional - if omitted an empty string will be send as response |
## protocol
* [protocol](#module_protocol)
* [.encodeRequest(method, data)](#module_protocol.encodeRequest) ⇒ Buffer
* [.encodeResponse(data)](#module_protocol.encodeResponse) ⇒ Buffer
* [.encodeData(obj)](#module_protocol.encodeData) ⇒ Buffer
* [.encodeStruct(obj)](#module_protocol.encodeStruct) ⇒ Buffer
* [.encodeStructKey(str)](#module_protocol.encodeStructKey) ⇒ Buffer
* [.encodeArray(arr)](#module_protocol.encodeArray) ⇒ Buffer
* [.encodeString(str)](#module_protocol.encodeString) ⇒ Buffer
* [.encodeBool(b)](#module_protocol.encodeBool) ⇒ Buffer
* [.encodeInteger(i)](#module_protocol.encodeInteger) ⇒ Buffer
* [.encodeDouble(d)](#module_protocol.encodeDouble) ⇒ Buffer
* [.decodeDouble(elem)](#module_protocol.decodeDouble) ⇒ object
* [.decodeString(elem)](#module_protocol.decodeString) ⇒ object
* [.decodeBool(elem)](#module_protocol.decodeBool) ⇒ object
* [.decodeInteger(elem)](#module_protocol.decodeInteger) ⇒ object
* [.decodeArray(elem)](#module_protocol.decodeArray) ⇒ object
* [.decodeStruct(elem)](#module_protocol.decodeStruct) ⇒ object
* [.decodeData(data)](#module_protocol.decodeData) ⇒ \*
* [.decodeResponse(data)](#module_protocol.decodeResponse) ⇒ \*
* [.decodeStrangeRequest(data)](#module_protocol.decodeStrangeRequest) ⇒ Array
* [.decodeRequest(data)](#module_protocol.decodeRequest) ⇒ \*
### protocol.encodeRequest(method, data) ⇒ Buffer
encode requests
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| method | string | throws error if not type string or if string is empty |
| data | \* | optional - defaults to an empty array |
### protocol.encodeResponse(data) ⇒ Buffer
encode response
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| data | \* | optional - defaults to empty string |
### protocol.encodeData(obj) ⇒ Buffer
encode data
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| obj | \* | throws TypeError if obj is undefined or null |
### protocol.encodeStruct(obj) ⇒ Buffer
encode struct
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| obj | object | throws error if not of type object |
### protocol.encodeStructKey(str) ⇒ Buffer
encode struct key
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| str | string | throws error if not of type string |
### protocol.encodeArray(arr) ⇒ Buffer
encode array
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| arr | array | throws error if not instance of Array |
### protocol.encodeString(str) ⇒ Buffer
encode string
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| str | string | throws error if not of type string |
### protocol.encodeBool(b) ⇒ Buffer
encode bool
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| b | \* | any type |
### protocol.encodeInteger(i) ⇒ Buffer
encode integer
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| i | number | throws error if not a number or if out of range (min=-2147483648 max=2147483647) |
### protocol.encodeDouble(d) ⇒ Buffer
encode double
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| d | number | throws error if not a number |
### protocol.decodeDouble(elem) ⇒ object
decode double
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <8 |
### protocol.decodeString(elem) ⇒ object
decode string
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <4 |
### protocol.decodeBool(elem) ⇒ object
decode double
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <8 |
### protocol.decodeInteger(elem) ⇒ object
decode integer
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <4 |
### protocol.decodeArray(elem) ⇒ object
decode array
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <4 |
### protocol.decodeStruct(elem) ⇒ object
decode struct
**Kind**: static method of [protocol](#module_protocol)
**Returns**: object - properties content and rest
| Param | Type | Description |
| --- | --- | --- |
| elem | Buffer | throws error if not an instance of Buffer or if length <4 |
### protocol.decodeData(data) ⇒ \*
decodes binary data
**Kind**: static method of [protocol](#module_protocol)
| Param | Type |
| --- | --- |
| data | Buffer |
### protocol.decodeResponse(data) ⇒ \*
decode response
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| data | Buffer | throws TypeError if data is no instance of Buffer |
### protocol.decodeStrangeRequest(data) ⇒ Array
decode "strange" request
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| data | Buffer | throws TypeError if data is no instance of Buffer |
### protocol.decodeRequest(data) ⇒ \*
decode request
**Kind**: static method of [protocol](#module_protocol)
| Param | Type | Description |
| --- | --- | --- |
| data | Buffer | throws TypeError if not instance of Buffer |
## server
## Client
**Kind**: global class
### new Client(options)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| options | object | | |
| options.host | string | | the hostname or ip address to connect to |
| options.port | number | | the port to connect to |
| [options.reconnectTimeout] | number | 2500 | wait milliseconds until trying to reconnect after the socket was closed |
| [options.responseTimeout] | number | 5000 | wait milliseconds for method call response |
| [options.queueMaxLength] | number | 15 | maximum number of methodCalls that are allowed in the queue |
## Protocol
**Kind**: global class
## Server
**Kind**: global class
* [Server](#Server)
* [new Server(options, onListening)](#new_Server_new)
* ["[method]" (error, params, callback)](#Server+event_[method])
* ["NotFound" (method, params)](#Server+event_NotFound)
### new Server(options, onListening)
| Param | Type | Description |
| --- | --- | --- |
| options | object | |
| options.host | string | ip address on which the server should listen |
| options.port | number | port on which the server should listen |
| onListening | function | function to be invoked in the server's `listening` callback |
### "[method]" (error, params, callback)
Fires when RPC method call is received
**Kind**: event emitted by [Server](#Server)
| Param | Type | Description |
| --- | --- | --- |
| error | \* | |
| params | array | |
| callback | function | callback awaits params err and response |
### "NotFound" (method, params)
Fires if a RPC method call has no event handler.
RPC response is always an empty string.
**Kind**: event emitted by [Server](#Server)
| Param | Type |
| --- | --- |
| method | string |
| params | array |