ee-net
Simple tcp client / server for easy json objects / data transmission supporting tls
installation
npm install ee-net
build status
usage
The Server and Connection class do have almost all properties and events of the native node.js «net» API. see net API
server
constructor
The constructor of the server class takes the options described at tls.createServer for a tls enabled server and the options described at net.createServer for non tls mode. you may pass a port and a host option as well.
var net = require( "ee-net" );
var server = new net.Server( { port: 9999 } );
«connection» event
The connection event is called when a client has established a new connection on the server
server.on( "connection", function( connection ){
// see the «connection» chapter below for the docs on connections
} );
connection
constructor
The constructor of the connection class takes the options described at tls.connect for tls enabled connections and the options «port» and «host» for non tls enabled connections.
var connection = new net.Connection( { host: 10.0.1.2, port: 9999 } );
«message» event
The message event is called when a message was received and decoeded successfully
connection.on( "message", function( message ){
log( message );
} )
send method
You may transmit messages using the «send» method
connection.send( { myJSON: "object" } );
remote / local property
The remote and local property return the remote / local ip / host configuration of the connection
log( connection.remote ); // { address: 10.0.1.2, family: "IPv4", port: 9999 }
example of a super simple echo server running on localhost
var net = require( "ee-net" )
, server = new net.Server().listen();
server.on( "conenction", function( connection ){
connection.on( "message", function( msg ){
log( msg ); // { hi: "fabian" }
connection.send( msg );
} );
} );
// wait until the server is online so we know its port
server.on( "listening", function(){
var client = new Connection( {
port: server.address.port
} );
client.on( "message", function( msg ){
log( msg ); // { hi: "fabian" }
} );
client.send( { hi: "fabian" } );
} );
cutom protocol implementation
You may implement custom protocol handlers, see ee-protocol-json for more information. You may pass an alternative protocol implementation to the constructors of the Server / Connection using the «protocol» property of the options object.