Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 380863 of WebRTC data channels

  • Revision slug: Games/WebRTC_data_channels
  • Revision title: WebRTC data channels
  • Revision id: 380863
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment

Revision Content

{{SeeCompatTable}}

The WebRTC (Web Real-Time Communications) API is primarily known for its support for audio and video communications; however, it also offers peer-to-peer data channels. This article explains more about this, and shows you how to use libraries to implement data channels in your game.

What is a data channel?

A WebRTC data channel lets you send text or binary data over an active connection to a peer. In the context of a game, this lets players send data to each other, whether text chat or game status information. Data channels come in two flavors.

Reliable channels guarantee that messages you send arrive at the other peer and in the same order in which they're sent. This is analogous to a TCP socket.

Unreliable channels make no such guarantees; messages aren't guaranteed to arrive in any particular order and, in fact, aren't guaranteed to arrive at all. This is analogous to a UDP socket.

We have documentation for using WebRTC. This article, however, will take advantage of some libraries that can help trivialize the work, and will demonstrate ways to use abstraction to work around implementation differences between browsers. Hopefully, of course, those differences will fade away in time.

Using the p2p library

One library you can use is the p2p library. This library provides a simple API for creating peer connections and setting up streams and data channels. There's also a broker server component and a hosted broker you can use instead of having to set one up for yourself.

<<MORE TO COME>>

Browser compatibility

Currently, to use WebRTC data channels, you'll need a build of Firefox Nightly or of Chrome Canary. They also work on Firefox OS.

Note: We need a formal compatibility table here at some point.

 

Revision Source

<p>{{SeeCompatTable}}</p>
<p>The <a href="/en-US/docs/WebRTC" title="/en-US/docs/WebRTC">WebRTC</a> (Web Real-Time Communications) API is primarily known for its support for audio and video communications; however, it also offers peer-to-peer data channels. This article explains more about this, and shows you how to use libraries to implement data channels in your game.</p>
<h2 id="What_is_a_data_channel.3F">What is a data channel?</h2>
<p>A WebRTC data channel lets you send text or binary data over an active connection to a peer. In the context of a game, this lets players send data to each other, whether text chat or game status information. Data channels come in two flavors.</p>
<p><strong>Reliable channels</strong> guarantee that messages you send arrive at the other peer and in the same order in which they're sent. This is analogous to a TCP socket.</p>
<p><strong>Unreliable channels</strong> make no such guarantees; messages aren't guaranteed to arrive in any particular order and, in fact, aren't guaranteed to arrive at all. This is analogous to a UDP socket.</p>
<p>We have <a href="/en-US/docs/WebRTC" title="/en-US/docs/WebRTC">documentation for using WebRTC</a>. This article, however, will take advantage of some libraries that can help trivialize the work, and will demonstrate ways to use abstraction to work around implementation differences between browsers. Hopefully, of course, those differences will fade away in time.</p>
<h2 id="Using_the_p2p_library">Using the p2p library</h2>
<p>One library you can use is the <a href="https://github.com/js-platform/p2p" title="https://github.com/js-platform/p2p">p2p</a> library. This library provides a simple API for creating peer connections and setting up streams and data channels. There's also a broker server component and a hosted broker you can use instead of having to set one up for yourself.</p>
<p>&lt;&lt;MORE TO COME&gt;&gt;</p>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>Currently, to use WebRTC data channels, you'll need a build of <a href="https://nightly.firefox.org" title="https://nightly.firefox.org">Firefox Nightly</a> or of <a href="https://www.google.com/intl/en/chrome/browser/canary.html" title="https://www.google.com/intl/en/chrome/browser/canary.html">Chrome Canary</a>. They also work on <a href="/en-US/docs/Mozilla/Firefox_OS" title="/en-US/docs/Mozilla/Firefox_OS">Firefox OS</a>.</p>
<div class="note">
  <p><strong>Note:</strong> We need a formal compatibility table here at some point.</p>
</div>
<p>&nbsp;</p>
Revert to this revision