Linear JavaScript

Overview

a msgpack-rpc + α implementation for JavaScript language.

Build Instrunctions

Required tools and Dependencies

• Java Runtime ver.1.6 or later
  for JsTestDriver, closure-compiler and jsdoc-toolkit

How to make and how to use

$ make
$ cp src/linear.min.js /path/to/somewhere

Make targets

• all
  same as pack
  NOTE
  linear.js and msgpack.codec.js are packed with by closure-compiler.
  http://code.google.com/p/closure-compiler/

• pack
  Pack linear.js and msgpack.codec.js into linear.min.js and linear.debug.js
  You can use linear apis only including linear.min.js or linear.debug.js at your web application.
  

  // minified
  <script type='text/javascript' src='linear.min.js'>

  // not minified
  <script type='text/javascript' src='linear.debug.js'>

• check-all/check
  Do test linear.js on localhost with by JsTestDriver.
  http://code.google.com/p/js-test-driver/
  NOTE for tests
  Test servers use TCP port number 4224 to 4229.

• start-servers
  Only run test servers for linear.js.

• run-tests
  Run tests.
  You can test linear.js with mobile browsers and remote browsers as follows.
  

  1. make start-servers
  2. Access http://host:port/ with your remote browsers.
  3. make run-tests

• stop-servers
  Kill test servers.

• doc
  Create api document for linear-js.
  NOTE for documentation
  Documents are created with by jsdoc-toolkit.
  http://code.google.com/p/jsdoc-toolkit/

• clean
  Cleanup dirs and remove documents, linear.min.js and linear.debug.js.

Additional Informations

When you use HTTP Authentication(RFC2617), WebSocket transport to cross origin will not work well on some browsers.
Please refer to this issue for HTTP Authentication.

Version Policy

• major
  APIs and specifications are changed significantly, so you need to update server and client applications at the same time.
• minor
  APIs are changed only slightly, so you need to rewrite applications if using appropriate APIs.
• revision
  Bug fixes and security fixes etc.

License

The MIT License (MIT)
See LICENSE for details.

And linear-js is using patched version of mspack.codec.js.
Original code is at https://github.com/uupaa/msgpack.js

/*!{id:msgpack.codec.js,ver:1.05,license:"MIT",author:"uupaa.js@gmail.com"}*/

And diff from original code is at deps/msgpack.js/uuppa_msgpack_codec_js.diff