Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.59 KB

README.markdown

File metadata and controls

37 lines (20 loc) · 1.59 KB

This library implements a backplane server and client on NodeJS.

Links

Installation

npm install backplane

Usage

This library includes 3 major components. A client for periodically polling an existing backplane server, a backplane server that runs on a plain node installation and a backplane server designed to work with connect.

Client:

The client is used to poll an existing backplane server for messages. Once created it will check the backplane server for new messages at a specified interval.

<script src="http://gist-it.appspot.com/github/digitalbutter/node-backplane/raw/master/Examples/backplanePoller/poller.js"></script>

Connect Server:

This component implements a response handler for using with the Connect middleware framework.

<script src="http://gist-it.appspot.com/github/digitalbutter/node-backplane/raw/master/Examples/backplaneServer/connect.js"></script>

Plain Node Server:

This component allows you to create a backplane server on a vanilla node installation.

<script src="http://gist-it.appspot.com/github/digitalbutter/node-backplane/raw/master/Examples/backplaneServer/node.js"></script>

License

This library is licensed under the MIT license. A copy of this can be found here