RTCPeerConnection: phương thức createDataChannel()

Cú pháp

createDataChannel(label)
createDataChannel(label, options)

Tham số

label

Tên dễ đọc cho kênh. Chuỗi này không được dài hơn 65.535 byte.

options Optional

Đối tượng cung cấp các tùy chọn cấu hình cho kênh dữ liệu. Nó có thể chứa các trường sau:

ordered Optional

Cho biết các thông điệp gửi trên RTCDataChannel có bắt buộc phải đến đúng thứ tự như lúc gửi (true) hay được phép đến không theo thứ tự (false). Mặc định: true.

maxPacketLifeTime Optional

Số mili giây tối đa mà việc truyền một thông điệp có thể mất trong chế độ không đáng tin cậy. Mặc dù giá trị này là một số nguyên không dấu 16 bit, mỗi user agent có thể giới hạn nó xuống mức tối đa mà nó cho là phù hợp. Mặc định: null.

maxRetransmits Optional

Số lần tối đa mà user agent nên cố gắng truyền lại một thông điệp nếu lần đầu thất bại trong chế độ không đáng tin cậy. Mặc dù giá trị này là một số nguyên không dấu 16 bit, mỗi user agent có thể giới hạn nó xuống mức tối đa mà nó cho là phù hợp. Mặc định: null.

protocol Optional

Tên của giao thức con được dùng trên RTCDataChannel, nếu có; nếu không thì là chuỗi rỗng (""). Mặc định: chuỗi rỗng (""). Chuỗi này không được dài hơn 65.535 byte.

negotiated Optional

Theo mặc định (false), các kênh dữ liệu được thương lượng trong băng, nơi một bên gọi createDataChannel, và bên kia lắng nghe sự kiện RTCDataChannelEvent bằng trình xử lý sự kiện ondatachannel. Ngoài ra (true), chúng có thể được thương lượng ngoài băng, nơi cả hai bên gọi createDataChannel với một ID đã thống nhất. Mặc định: false.

id Optional

ID số 16 bit cho kênh; giá trị hợp lệ là từ 0 đến 65534. Nếu bạn không bao gồm tùy chọn này, user agent sẽ chọn một ID cho bạn.

Giá trị trả về

Một đối tượng RTCDataChannel mới với label được chỉ định, được cấu hình bằng các tùy chọn trong options nếu tham số đó được bao gồm; nếu không, các giá trị mặc định được liệt kê ở trên sẽ được áp dụng.

Ngoại lệ

InvalidStateError DOMException

Ném ra nếu RTCPeerConnection đã đóng.

TypeError

Ném ra trong các trường hợp sau:

• Chuỗi label và/hoặc protocol quá dài; chúng không được dài hơn 65.535 byte (byte chứ không phải ký tự).
• id là 65535. Mặc dù đây là một giá trị hợp lệ của số nguyên không dấu 16 bit, nó không phải là giá trị được phép cho id.

SyntaxError DOMException

Ném ra nếu cả maxPacketLifeTime và maxRetransmits đều được chỉ định. Bạn chỉ được phép chỉ định một trong hai giá trị này khác null.

ResourceInUse DOMException

Ném ra nếu id đã được chỉ định nhưng một RTCDataChannel khác đang dùng cùng giá trị đó.

OperationError DOMException

Ném ra nếu id được chỉ định đã được dùng, hoặc nếu không chỉ định id, lớp WebRTC không thể tự động tạo ID vì tất cả ID đều đã được dùng.

Ví dụ

Ví dụ này cho thấy cách tạo một data channel và thiết lập trình xử lý cho các sự kiện open và message để gửi và nhận thông điệp trên đó (để ngắn gọn, ví dụ giả định onnegotiationneeded đã được thiết lập).

// Phía bên mời

const pc = new RTCPeerConnection(options);
const channel = pc.createDataChannel("chat");
channel.onopen = (event) => {
  channel.send("Hi you!");
};
channel.onmessage = (event) => {
  console.log(event.data);
};

// Phía bên trả lời

const pc = new RTCPeerConnection(options);
pc.ondatachannel = (event) => {
  const channel = event.channel;
  channel.onopen = (event) => {
    channel.send("Hi back!");
  };
  channel.onmessage = (event) => {
    console.log(event.data);
  };
};

Ngoài ra, bạn có thể dùng thương lượng ngoài băng đối xứng hơn bằng một id đã thống nhất (ở đây là 0):

// Cả hai phía

const pc = new RTCPeerConnection(options);
const channel = pc.createDataChannel("chat", { negotiated: true, id: 0 });
channel.onopen = (event) => {
  channel.send("Hi!");
};
channel.onmessage = (event) => {
  console.log(event.data);
};

Để xem ví dụ kỹ hơn về cách thiết lập kết nối và kênh, xem Một mẫu RTCDataChannel đơn giản.

Thông số kỹ thuật

Tương thích trình duyệt

Xem thêm

• RTCDataChannel
• Một mẫu RTCDataChannel đơn giản
• RTCPeerConnection