<header>

<h1>BinaryJS</h1>

<p>Realtime binary streaming for the web using websockets</p>

<p class="view"><a href="https://github.com/binaryjs/binaryjs/blog/master/doc/start.md">Get Started</a></p>

<p class="view"><a href="https://github.com/binaryjs/binaryjs/tree/master/doc">Documentation</a></p>

<p class="view"><a href="https://github.com/binaryjs/binaryjs/tree/master/examples">Examples / Demos</a></p>

<p class="view"><a href="http://groups.google.com/group/binaryjs-group">Mailing List</a> / <a href="https://twitter.com/binaryjs">Twitter</a> / <a href="https://github.com/binaryjs/binaryjs">GitHub</a></p>

<p><a href="https://secure.travis-ci.org/binaryjs/binaryjs"><img src="https://secure.travis-ci.org/binaryjs/binaryjs.png"></a></p>

stream.end();

});

<p>

<a href="https://github.com/binaryjs/binaryjs/blob/master/doc/start.md">View the "Getting Started" guide</a>

</p>

<p>

<a href="https://github.com/binaryjs/binaryjs/blob/master/doc/api.md">View the API reference</a>

</p>

<p>

<a href="https://github.com/binaryjs/binaryjs/tree/master/examples/helloworld">View the "Hello world" example</a>

</p>

<p>

<a href="https://github.com/binaryjs/binaryjs/tree/master/examples">See more examples</a>

</p>

<h3>What can you do with this?</h3>

<p>Both the server and the client can write or accept any arbitrary JSON type or structure &#8211; Objects, arrays, null, booleans, strings &#8211; and also binary data. Because BinaryPack is a binary protocol, the wire format has negligible serialization/deserialization overhead for large chunks of binary data. This also means binary data types such as Buffer in Node.js and Blob or ArrayBuffer in the client can be serialized and deserialized.</p>

<p>On the client, feature detection is employed to choose between using BlobBuilder, the Blob constructor, and ArrayBufferViews or ArrayBuffers themselves for assembling Blobs for transport.</p>

<p>When using `stream.write` data chunking is up to the caller. When a stream is piped, it is up to the source stream to chunk data. When sending a larger binary type using `client.send` a new stream is created and the buffer will piped into the stream in chunks automatically.</p>

<p>For piped streams, BinaryJS correctly provides boolean return values from `stream.write` calls so that if the socket buffer is full, the incoming stream is paused. This poewrful cascade of stream throttling allows large streams to be transferred without execessive memory use.</p>

<h3>Future plans</h3>

<p>The items below are in no particular order. If you would like to contribute go ahead and issue a pull request or email me at <a href="mailto:really.ez+1010@gmail.com">really.ez+1010@gmail.com</a></p>

<ul>

<li>Improved <a href="https://github.com/binaryjs/js-binarypack">BinaryPack</a> serialization performance, including a native C++ module for <a href="https://github.com/binaryjs/node-binarypack">node-binarypack</a></li>

<li>Fallbacks (either with Flash or XHR2) for non-binary-websocket browsers</li>

<li>iOS and Android clients</li>

<li>Ruby, Python, Java servers</li>

</ul>

<h3>Support and questions</h3>

<p>If you need help with BinaryJS please add questions to the <a href="http://groups.google.com/group/binaryjs-group">mailing list</a>. Otherwise you can email me at <a href="mailto:really.ez+1010@gmail.com">really.ez+1010@gmail.com</a></p>

</section>

<footer>

<p><iframe src="http://markdotto.github.com/github-buttons/github-btn.html?user=binaryjs&repo=binaryjs&type=watch"

allowtransparency="true" frameborder="0" scrolling="0" width="62px" height="20px"></iframe>&nbsp;&nbsp;<iframe src="http://markdotto.github.com/github-buttons/github-btn.html?user=binaryjs&repo=binaryjs&type=fork"

allowtransparency="true" frameborder="0" scrolling="0" width="62px" height="20px"></iframe><a href="https://twitter.com/binaryjs" class="twitter-follow-button" data-show-count="false">Follow @binaryjs</a>

<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script><br><small><a href="http://ericzhang.com">Built by Eric Zhang</a> &dash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>

</footer>

</div>

<a href="https://github.com/binaryjs/binaryjs"><img style="position: fixed; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>