floca-socket-client

Client for webapps to connect to services in a floca-based projects published via REST.

Usage

Require your connector:

var Connector = require('floca-rest-client');

Then initialise it:

var options = {
	harconName: 'Floca',
	jwtRequestPath: '/sys/request-a-token', // optional
	API_KEY: 'SecretKeyHere' // optional
};
Connector.init( options, function(err, res){});

You have to specify the name of the floca-server you want to connect-to. If the floca-services are protected by API_KEY and/or JWT, you can set the attributes to support them.

Floca might expose services following the REST pattern or the Harcon RPC

The Connector possesses 2 functions to support both protocols with the same signature.

For REST services, use the function harconREST as below:

var options = {};
Connector.harconREST( division, context, service, params, options, function(err, res){ } );
} );

If the floca-service is exposed through Harcon RPC, use the function harcomm as below:

var options = {};
Connector.harcomm( division, context, service, params, options, function(err, res){ } );
} );

Addressing follows the logic of harcon used by floca heavily.

And you are ready to go!

Please check the other client connectors : for AMQP and for Websocket