From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- files/zh-cn/web/api/rtcdatachannel/index.html | 177 ++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 files/zh-cn/web/api/rtcdatachannel/index.html (limited to 'files/zh-cn/web/api/rtcdatachannel/index.html') diff --git a/files/zh-cn/web/api/rtcdatachannel/index.html b/files/zh-cn/web/api/rtcdatachannel/index.html new file mode 100644 index 0000000000..ff3ac46500 --- /dev/null +++ b/files/zh-cn/web/api/rtcdatachannel/index.html @@ -0,0 +1,177 @@ +--- +title: RTCDataChannel +slug: Web/API/RTCDataChannel +translation_of: Web/API/RTCDataChannel +--- +

{{APIRef("WebRTC")}}{{SeeCompatTable}}

+ +

RTCDataChannel接口代表在两者之间建立了一个双向数据通道的连接。

+ +

可以用{{domxref("RTCDataChannel.createDataChannel()")}}或者在现有的 {{domxref("RTCPeerConnection")}}上用 {{domxref("RTCDataChannelEvent")}}类型的 {{event("datachannel")}} 事件接收，创建出 RTCDataChannel类型的对象。

+ +
+

这个API在Gecko中被称作DataChannel而不是标准的'RTCDataChannel'。

+
+ +

属性

+ +
+
{{domxref("RTCDataChannel.label")}} {{readOnlyInline}}
+
返回一个包含有描述数据通道名字的{{domxref("DOMString")}}。这个字段没有唯一性要求。
+
{{domxref("RTCDataChannel.ordered")}} {{readOnlyInline}}
+
返回一个{{domxref("Boolean")}}对象，表示传递信息的顺序是否有保证。
+
{{domxref("RTCDataChannel.protocol")}} {{readOnlyInline}}
+
返回一个包含有正在使用的子协议的名称的 {{Domxref("DOMString")}}，如果没有这样的子协议，返回""
+
{{domxref("RTCDataChannel.id")}} {{readOnlyInline}}
+
当{{domxref("RTCDataChannel")}}对象被创建出来的时候，返回一个无符号short类型的数据，作为通道的标识id。
+
{{domxref("RTCDataChannel.readyState")}} {{readOnlyInline}}
+
返回枚举类型的 RTCDataChannelState，表示数据连接的状态，有以下几种类型： +
    +
  • "connecting" 该状态表示底层链路还未建立和激活，该状态还是由{{domxref("RTCPeerConnection.createDataChannel()")}}生成的datachannel初始状态。
    • +
  • "open" 该状态表示底层链路已经连接成功并且运行。这个状态还是由{{domxref("RTCDataChannelEvent")}}分发的datachannel的初始状态。 
    • +
  • "closing" 该状态表示底层链路已经在关闭的过程中。该状态下将不会接受新的发送任务，但是缓冲队列中的消息还是会被继续发送或者接收。
    • +
  • "closed" 该状态表示底层链路已经完全被关闭（或者无法处于established状态）。
    • +
+
+
{{domxref("RTCDataChannel.bufferedAmount")}} {{readOnlyInline}}
+
+

返回一个unsigned long，表示缓冲队列中等待发送的字节数。这些数据是通过{{domxref("RTCDataChannel.send()")}}添加进缓冲队列但还未被发送的数据请求。注意：就算channel处于closed状态，队列中的缓存还会保持。

+
+
{{domxref("RTCDataChannel.binaryType")}}
+
+

是一个{{domxref("DOMString")}} 类型，表示由链路发送的二进制数据的类型。该项的值应该为"blob"或者"arraybuffer"，默认值为"blob"。当值为"blob"的时候，使用{{domxref("Blob")}}对象，当值为"arraybuffer"时，使用{{domxref("ArrayBuffer")}}对象

+
+
{{domxref("RTCDataChannel.maxPacketLifeType")}} {{readOnlyInline}}
+
是一个unsigned short类型，表示不可靠模式下的消息发送允许时间长度，单位为毫秒。
+
{{domxref("RTCDataChannel.maxRetransmits")}} {{readOnlyInline}}
+
是一个unsigned short类型，表示不可靠模式下消息允许尝试重发的最大次数。
+
{{domxref("RTCDataChannel.negotiated")}} {{readOnlyInline}}
+
是一个{{domxref("Boolean")}}类型，表示这个channel是否已经通过应用协商。
+
{{domxref("DataChannel.reliable")}} {{non-standard_inline}} {{readOnlyInline}}
+
是一个{{domxref("Boolean")}}类型，表示这个链接能不能以非可靠模式发送消息。已经废弃的api。
+
{{domxref("DataChannel.stream")}} {{non-standard_inline}} {{readOnlyInline}}
+
和{{domxref("RTCDataChannel.id")}}等效，已经废弃的api。
+
+ +

事件处理器

+ +
+
{{domxref("RTCDataChannel.onopen")}}
+
当接收到{{event("open")}} 事件时的事件处理器，当底层链路数据传输成功，端口状态处于established的时候会触发该事件。
+
{{domxref("RTCDataChannel.onmessage")}}
+
当接收到{{event("message")}}事件时的事件处理器。当有数据被接收的时候会触发该事件。
+
{{domxref("RTCDataChannel.onclose")}}
+
当接收到{{event("close")}}事件时候的事件处理器。当底层链路被关闭的时候会触发该事件。
+
{{domxref("RTCDataChannel.onerror")}}
+
当接收到{{event("error")}} 事件时候的事件处理器。当遇到错误的时候会触发该事件。
+
+ +

方法

+ +
+
{{domxref("RTCDataChannel.close()")}}
+
+

关闭channel的方法。这个关闭动作不是直接生效的。这个方法会将channel的{{domxref("RTCDataChannel.readyState", "state")}} 属性设置为"closing"状态，在消息队列中的消息全部发送完毕之后，channel才会被关闭。

+
+
{{domxref("RTCDataChannel.send()")}}
+
将参数中的数据通过channel发送。这个数据可以是{{domxref("DOMString")}}, {{domxref("Blob")}}, {{domxref("ArrayBuffer")}}或者是 {{domxref("ArrayBufferView")}}类型。
+
+ +

Example

+ +
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");
+};
+
+ +

 

+ +

Specifications

+ + + + + + + + + + + + + + + + +
SpecificationStatusComment
{{ SpecName('WebRTC 1.0', '#idl-def-RTCDataChannel', 'RTCDataChannel') }}{{ Spec2('WebRTC 1.0') }}Initial specification.
+ +

Browser compatibility

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + + + +
FeatureChromeFirefox (Gecko)Internet ExplorerOperaSafari
Basic support{{ CompatVersionUnknown() }}{{ CompatVersionUnknown }} [1]{{ CompatNo() }}{{ CompatVersionUnknown() }}{{ CompatUnknown() }}
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
FeatureAndroidChrome for AndroidFirefox Mobile (Gecko)IE MobileOpera MobileSafari Mobile
Basic support{{ CompatUnknown() }}{{ CompatUnknown() }}{{ CompatUnknown() }}{{ CompatNo() }}{{ CompatUnknown() }}{{ CompatUnknown() }}
+
+ +

[1] The interface is called DataChannel and not RTCDataChannel

+ +

See also

+ + -- cgit v1.2.3-54-g00ecf