callosum-server-tcp
Stability: 1 - Experimental
TCP Server for Callosum: a self-balancing distributed services protocol.
Usage
var CallosumServer = ;var callosumServer = host: 'localhost' port: 4040; callosumServer; callosumServer; callosumServer; callosumServer;
Tests
npm test
Overview
TCP Server for Callosum, which is an open-source implementation of Indeed's Boxcar: A self-balancing distributed services protocol.
Callosum TCP Server Protocol
When a new client connects to a TCP CallosumServer, the server will respond with the slot number assigned to the connection by sending a slot number followed by \r\n
. For example, for slot 13
:
13\r\n
This is all the information necessary for a client to either accept the slot, and keep the connection, or reject the slot by breaking the connection.
Documentation
CallosumServer
- CallosumServer.listen(options, [callback])
- new CallosumServer(options)
- callosumServer.close([callback])
- callosumServer.listen([callback])
- Event 'connection'
- Event 'error'
- Event 'slot free'
- Event 'slot request'
CallosumServer.listen(options, [callback])
options
: Seenew CallosumServer(options)
options
.callback
: SeecallosumServer.listen(callback)
callback
.- Return: Object An instance of CallosumServer with server running.
Creates a new CallosumServer and starts the server.
new CallosumServer(options)
options
: Objecthost
: String (Default: undefined) Hostname for the server to listen on. If not specified, the server will accept connections directed to any IPv4 address (INADDR_ANY
).port
: Integer (Default: 4040) Port number for the server to listen on.
Creates a new CallosumServer instance.
callosumServer.close([callback])
callback
: Function (Default: undefined)function () {}
Optional callback to call once the server is stopped.
Stops the server from accepting new connections.
callosumServer.listen([callback])
callback
: Function (Default: undefined)function () {}
Optional callback to call once the server is up.
Starts the server to listen to new connections.
connection
Event function (connection) {}
connection
: Socket object The connection object.
Emitted once the connection is assigned a new slot via a callback
to the slot request
event.
error
Event function (error) {}
error
: Object An error that occurred.
Emitted when CallosumServer encounters an error. If no handler is registered, an exception will be thrown.
slot free
Event function (slot) {}
slot
: Integer Slot number to free.
Emitted when the a connection with previously assigned slot
is broken.
slot request
Event function (callback) {}
callback
: Functionfunction (error, slot) {}
The callback to call with the next available slot number.
Emitted when a new connection from a client is made.