RTCDataChannel

RTCDataChannel インターフェイスは、2 つのピア間で双方向に任意のデータを転送するためのネットワークチャンネルを表現します。すべてのデータチャンネルは RTCPeerConnection に関連付けられており、それぞれのぴあコネクションは理論上、最大 65,534 個のデータチャンネルを持つことができます (実際の上限はブラウザーごとに異なります)。

データチャンネルを作成してリモートのピアに参加するかを問い合わせるには、RTCPeerConnection の createDataChannel() (en-US) メソッドを呼び出します。データ交換に招かれているピアは datachannel イベント (RTCDataChannelEvent 型) を受け取って、コネクションにデータチャンネルが追加されたことを知ります。

プロパティ

RTCDataChannel.label (en-US) 読取専用

データチャネルを示す名前を含むDOMStringを返します。この値に関して固有でなければならない制約はありません。

RTCDataChannel.ordered (en-US) 読取専用

メッセージの配達順序を保証するかしないかを示すBooleanを返します。

RTCDataChannel.protocol (en-US) 読取専用

利用している副プロトコルの名前を含むDOMStringを返します。ない場合は ""を返します。

RTCDataChannel.id (en-US) 読取専用

このチャンネルの固有 ID を示す unsigned short を返します。この値は、RTCDataChannelオブジェクトの作成時に設定されます。

RTCDataChannel.readyState (en-US) 読取専用

下位のデータコネクションの状態を表現する列挙型の RTCDataChannelState を返します。次のいずれかの値をとります。

  • "connecting": 下位のコネクションがまだ確立されておらず有効でないことを示します。RTCPeerConnection.createDataChannel() (en-US)によって生成されたデータチャネルの初期状態です。
  • "open": 下位のコネクションが確立され動作中であることを示します。RTCDataChannelEvent によって、データチャンネルがディスパッチされた時の初期状態です。
  • "closing": 下位のコネクションがシャットダウン処理中であることを示します。新しい送信タスクは受け付けませんが、送信または受信中のキャッシュされたメッセージは処理されます。
  • "closed": 下位のコネクションがシャットダウンされたこと(または、確立できなかったこと)を示します。
RTCDataChannel.bufferedAmount (en-US) 読取専用

送信キューのバイト量を含むunsigned longを返します。これは、RTCDataChannel.send() (en-US)を介して送信要求され、まだ送信されていないデータの量です。チャンネルが閉じている場合、バッファリングは継続することに注意してください。

RTCDataChannel.binaryType (en-US)

コネクションによって送信されたバイナリデータの種類を示すDOMStringです。この値は、Blobが利用されている場合は"blob"、ArrayBufferが利用されている場合は"arraybuffer"にすべきです。初期状態では、"blob"が設定されます。

RTCDataChannel.maxPacketLifeTime (en-US) 読取専用

無信頼性モードでのメッセージングでの、ミリ秒単位のウィンドウ長を示すunsigned shortです。

RTCDataChannel.maxRetransmits (en-US) 読取専用

無信頼性モードでのメッセージングでの、最大再送信回数を示すunsigned shortです。

RTCDataChannel.negotiated (en-US) 読取専用

アプリケーションによってチャンネルがネゴシエーションされたかされていなかを示すBooleanです。

DataChannel.reliable 読取専用

コネクションはメッセージを無信頼性モードで送信可能かを示すBooleanです。

DataChannel.stream 読取専用

旧式です。RTCDataChannel.id (en-US)と同じ意味を持ちます。

イベントハンドラ

RTCDataChannel.onopen (en-US)

open イベントを受信した時に呼ばれるイベントハンドラです。このイベントは、データコネクションのための下位のデータトランスポートが確立された時に送信されます。

RTCDataChannel.onmessage (en-US)

message イベントを受信した時に呼ばれるイベントハンドラです。このイベントは、データコネクション上でメッセージを受信した時に送信されます。

RTCDataChannel.onclose (en-US)

close イベントを受信した時に呼ばれるイベントハンドラです。このイベントは、下位のデータトランスポートが閉じた時に送信されます。

RTCDataChannel.onerror (en-US)

error イベントを受信した時に呼ばれるイベントハンドラです。このイベントは、エラーに遭遇した時に送信されます。

メソッド

RTCDataChannel.close() (en-US)

チャンネルを閉じます。突然でない方法でチャンネルを閉じます。チャンネルのstate (en-US) は "closing"に設定され、送信されていないメッセージは送信されてから、チャンネルを閉じます。

RTCDataChannel.send() (en-US)

チャンネルのパラメータに従いデータを送信します。送信可能なデータの型は DOMString　または Blob、 ArrayBuffer、ArrayBufferView (en-US) です。

例

var pc = new RTCPeerConnection();
var dc = pc.createDataChannel("my channel");

dc.onmessage = function (event) {
  console.log("received: " + event.data);
};

dc.onopen = function () {
  console.log("datachannel open");
};

dc.onclose = function () {
  console.log("datachannel close");
};

仕様

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# rtcdatachannel

ブラウザー互換性

BCD tables only load in the browser

関連情報