Skip to content

Latest commit

 

History

History
40 lines (22 loc) · 1.51 KB

README.md

File metadata and controls

40 lines (22 loc) · 1.51 KB

freebird-rpc

A RPC interface used for freebird web client and server to communicate with each other through WebSocket.

NPM

Travis branch npm npm


Documentation

Please visit the Wiki.


Overview

This module is a transportation with WebSocket protocol, which is used by the RPC interface of freebird framework. It provides methods to create RPC client and RPC server for real-time remote communications. The RPC server should be registered to freebird framework to be able to transmit freebird messages to RPC client (e.g., the web browser). And the RPC client is provided for webapp to be able to communicate with freebird.

See Overview on the Wiki for details.


Installation

$ npm install freebird-rpc --save


Usage

See Usage on the Wiki for details.


License

Licensed under MIT.