akasha.rtc

Class RTCDataChannel

java.lang.Object

akasha.EventTarget

akasha.rtc.RTCDataChannel

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="RTCDataChannel")
public class RTCDataChannel
extends EventTarget

The RTCDataChannel interface represents a network channel which can be used for bidirectional peer-to-peer transfers of arbitrary data. Every data channel is associated with an RTCPeerConnection, and each peer connection can have up to a theoretical maximum of 65,534 data channels (the actual limit may vary from browser to browser).

See Also:

RTCDataChannel - MDN, RTCDataChannel - WebRTC 1.0: Real-time Communication Between Browsers

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	binaryType The property binaryType on the RTCDataChannel interface is a DOMString which specifies the type of JavaScript object which should be used to represent binary data received on the RTCDataChannel.
int	bufferedAmountLowThreshold The RTCDataChannel property bufferedAmountLowThreshold is used to specify the number of bytes of buffered outgoing data that is considered "low." The default value is 0.
EventHandler	onbufferedamountlow The RTCDataChannel.onbufferedamountlow property is an EventHandler which specifies a function the browser calls when the bufferedamountlow event is sent to the RTCDataChannel.
EventHandler	onclose The RTCDataChannel.onclose property is an EventHandler which specifies a function to be called by the browser when the close event is received by the RTCDataChannel.
EventHandler	onclosing The RTCDataChannel.onclosing property is an EventHandler which specifies a function to be called by the browser when the closing event is received by the RTCDataChannel.
RTCErrorEventHandler	onerror The RTCDataChannel.onerror property is an EventHandler which specifies a function to be called when the error event is received.
MessageEventHandler	onmessage The RTCDataChannel.onmessage property stores an EventHandler which specifies a function to be called when the message event is fired on the channel.
RTCDataChannelEventHandler	onopen The RTCDataChannel.onopen property is an EventHandler which specifies a function to be called when the open event is fired; this is a simple Event which is sent when the data channel's underlying data transport—the link over which the RTCDataChannel's messages flow—is established or re-established.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RTCDataChannel()

Method Summary

Modifier and Type	Method and Description
void	addBufferedamountlowListener(EventListener callback)
void	addBufferedamountlowListener(EventListener callback, AddEventListenerOptions options)
void	addBufferedamountlowListener(EventListener callback, boolean useCapture)
void	addCloseListener(EventListener callback)
void	addCloseListener(EventListener callback, AddEventListenerOptions options)
void	addCloseListener(EventListener callback, boolean useCapture)
void	addErrorListener(RTCErrorEventListener callback)
void	addErrorListener(RTCErrorEventListener callback, AddEventListenerOptions options)
void	addErrorListener(RTCErrorEventListener callback, boolean useCapture)
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
void	addOpenListener(RTCDataChannelEventListener callback)
void	addOpenListener(RTCDataChannelEventListener callback, AddEventListenerOptions options)
void	addOpenListener(RTCDataChannelEventListener callback, boolean useCapture)
int	bufferedAmount() The read-only RTCDataChannel property bufferedAmount returns the number of bytes of data currently queued to be sent over the data channel.
void	close() The RTCDataChannel.close() method closes the RTCDataChannel.
java.lang.Double	id() The read-only RTCDataChannel property id returns an ID number (between 0 and 65,534) which uniquely identifies the RTCDataChannel.
java.lang.String	label() The read-only RTCDataChannel property label returns a DOMString containing a name describing the data channel.
java.lang.Double	maxPacketLifeTime() The read-only RTCDataChannel property maxPacketLifeTime returns the amount of time, in milliseconds, the browser is allowed to take to attempt to transmit a message, as set when the data channel was created, or null.
java.lang.Double	maxRetransmits() The read-only RTCDataChannel property maxRetransmits returns the maximum number of times the browser should try to retransmit a message before giving up, as set when the data channel was created, or null, which indicates that there is no maximum.
boolean	negotiated() The read-only RTCDataChannel property negotiated indicates whether the RTCDataChannel's connection was negotiated by the Web app (true) or by the WebRTC layer (false).
boolean	ordered() The read-only RTCDataChannel property ordered indicates whether or not the data channel guarantees in-order delivery of messages; the default is true, which indicates that the data channel is indeed ordered.
java.lang.String	priority()
java.lang.String	protocol() The read-only RTCDataChannel property protocol returns a DOMString containing the name of the subprotocol in use.
java.lang.String	readyState() The read-only RTCDataChannel property readyState returns an enum of type RTCDataChannelState which indicates the state of the data channel's underlying data connection.
void	removeBufferedamountlowListener(EventListener callback)
void	removeBufferedamountlowListener(EventListener callback, boolean useCapture)
void	removeBufferedamountlowListener(EventListener callback, EventListenerOptions options)
void	removeCloseListener(EventListener callback)
void	removeCloseListener(EventListener callback, boolean useCapture)
void	removeCloseListener(EventListener callback, EventListenerOptions options)
void	removeErrorListener(RTCErrorEventListener callback)
void	removeErrorListener(RTCErrorEventListener callback, boolean useCapture)
void	removeErrorListener(RTCErrorEventListener callback, EventListenerOptions options)
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)
void	removeOpenListener(RTCDataChannelEventListener callback)
void	removeOpenListener(RTCDataChannelEventListener callback, boolean useCapture)
void	removeOpenListener(RTCDataChannelEventListener callback, EventListenerOptions options)
void	send(ArrayBuffer data) The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.
void	send(ArrayBufferView data) The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.
void	send(Blob data) The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.
void	send(java.lang.String data) The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

binaryType

@Nonnull
 @BinaryType
public java.lang.String binaryType

The property binaryType on the RTCDataChannel interface is a DOMString which specifies the type of JavaScript object which should be used to represent binary data received on the RTCDataChannel. Values allowed by the WebSocket.binaryType property are also permitted here: "blob" if Blob objects are being used or "arraybuffer" if ArrayBuffer objects are being used. The default is "blob".

See Also:

RTCDataChannel.binaryType - MDN, RTCDataChannel.binaryType - WebRTC 1.0: Real-time Communication Between Browsers

bufferedAmountLowThreshold

public int bufferedAmountLowThreshold

The RTCDataChannel property bufferedAmountLowThreshold is used to specify the number of bytes of buffered outgoing data that is considered "low." The default value is 0.

See Also:

RTCDataChannel.bufferedAmountLowThreshold - MDN, RTCDataChannel.bufferedAmountLowThreshold - WebRTC 1.0: Real-time Communication Between Browsers

onbufferedamountlow

@Nullable
public EventHandler onbufferedamountlow

The RTCDataChannel.onbufferedamountlow property is an EventHandler which specifies a function the browser calls when the bufferedamountlow event is sent to the RTCDataChannel. This event, which is represented by a simple Event object, is sent when the amount of data buffered to be sent falls to or below the threshold specified by the channel's bufferedAmountLowThreshold.

See Also:

RTCDataChannel.onbufferedamountlow - MDN

onclose

@Nullable
public EventHandler onclose

The RTCDataChannel.onclose property is an EventHandler which specifies a function to be called by the browser when the close event is received by the RTCDataChannel. This is a simple Event which indicates that the data channel has closed down.

See Also:

RTCDataChannel.onclose - MDN, RTCDataChannel.onclose - WebRTC 1.0: Real-time Communication Between Browsers

onclosing

@Nullable
public EventHandler onclosing

The RTCDataChannel.onclosing property is an EventHandler which specifies a function to be called by the browser when the closing event is received by the RTCDataChannel. This is a simple Event which indicates that the data channel is being closed, that is, RTCDataChannel transitions to "closing" state. For example, after RTCDataChannel.close() was called but the underlying data transport might not have been closed yet.

See Also:

RTCDataChannel.onclosing - MDN, RTCDataChannel.onclosing - WebRTC 1.0: Real-time Communication Between Browsers

onerror

@Nullable
public RTCErrorEventHandler onerror

The RTCDataChannel.onerror property is an EventHandler which specifies a function to be called when the error event is received. When an error occurs on the data channel, the function receives as input an ErrorEvent object describing the error which occurred.

See Also:

RTCDataChannel.onerror - MDN, RTCDataChannel.onerror - WebRTC 1.0: Real-time Communication Between Browsers

onmessage

@Nullable
public MessageEventHandler onmessage

The RTCDataChannel.onmessage property stores an EventHandler which specifies a function to be called when the message event is fired on the channel. This event is represented by the MessageEvent interface. This event is sent to the channel when a message is received from the other peer.

See Also:

RTCDataChannel.onmessage - MDN, RTCDataChannel.onmessage - WebRTC 1.0: Real-time Communication Between Browsers

onopen

@Nullable
public RTCDataChannelEventHandler onopen

The RTCDataChannel.onopen property is an EventHandler which specifies a function to be called when the open event is fired; this is a simple Event which is sent when the data channel's underlying data transport—the link over which the RTCDataChannel's messages flow—is established or re-established.

See Also:

RTCDataChannel.onopen - MDN, RTCDataChannel.onopen - WebRTC 1.0: Real-time Communication Between Browsers

Constructor Detail

RTCDataChannel

protected RTCDataChannel()

Method Detail

bufferedAmount

@JsProperty(name="bufferedAmount")
public int bufferedAmount()

The read-only RTCDataChannel property bufferedAmount returns the number of bytes of data currently queued to be sent over the data channel.

See Also:

RTCDataChannel.bufferedAmount - MDN, RTCDataChannel.bufferedAmount - WebRTC 1.0: Real-time Communication Between Browsers

id

@JsProperty(name="id")
 @Nullable
public java.lang.Double id()

The read-only RTCDataChannel property id returns an ID number (between 0 and 65,534) which uniquely identifies the RTCDataChannel.

See Also:

RTCDataChannel.id - MDN, RTCDataChannel.id - WebRTC 1.0: Real-time Communication Between Browsers

label

@JsProperty(name="label")
 @Nonnull
public java.lang.String label()

The read-only RTCDataChannel property label returns a DOMString containing a name describing the data channel. These labels are not required to be unique.

See Also:

RTCDataChannel.label - MDN, RTCDataChannel.label - WebRTC 1.0: Real-time Communication Between Browsers

maxPacketLifeTime

@JsProperty(name="maxPacketLifeTime")
 @Nullable
public java.lang.Double maxPacketLifeTime()

The read-only RTCDataChannel property maxPacketLifeTime returns the amount of time, in milliseconds, the browser is allowed to take to attempt to transmit a message, as set when the data channel was created, or null.

See Also:

RTCDataChannel.maxPacketLifeTime - MDN, RTCDataChannel.maxPacketLifeTime - WebRTC 1.0: Real-time Communication Between Browsers

maxRetransmits

@JsProperty(name="maxRetransmits")
 @Nullable
public java.lang.Double maxRetransmits()

The read-only RTCDataChannel property maxRetransmits returns the maximum number of times the browser should try to retransmit a message before giving up, as set when the data channel was created, or null, which indicates that there is no maximum.

See Also:

RTCDataChannel.maxRetransmits - MDN, RTCDataChannel.maxRetransmits - WebRTC 1.0: Real-time Communication Between Browsers

negotiated

@JsProperty(name="negotiated")
public boolean negotiated()

The read-only RTCDataChannel property negotiated indicates whether the RTCDataChannel's connection was negotiated by the Web app (true) or by the WebRTC layer (false).

See Also:

RTCDataChannel.negotiated - MDN, RTCDataChannel.negotiated - WebRTC 1.0: Real-time Communication Between Browsers

ordered

@JsProperty(name="ordered")
public boolean ordered()

The read-only RTCDataChannel property ordered indicates whether or not the data channel guarantees in-order delivery of messages; the default is true, which indicates that the data channel is indeed ordered.

See Also:

RTCDataChannel.ordered - MDN, RTCDataChannel.ordered - WebRTC 1.0: Real-time Communication Between Browsers

priority

@JsProperty(name="priority")
 @Nonnull
 @RTCPriorityType
public java.lang.String priority()

protocol

@JsProperty(name="protocol")
 @Nonnull
public java.lang.String protocol()

The read-only RTCDataChannel property protocol returns a DOMString containing the name of the subprotocol in use. If no protocol was specified when the data channel was created, then this property's value is "" (the empty string).

See Also:

RTCDataChannel.protocol - MDN, RTCDataChannel.protocol - WebRTC 1.0: Real-time Communication Between Browsers

readyState

@JsProperty(name="readyState")
 @Nonnull
 @RTCDataChannelState
public java.lang.String readyState()

The read-only RTCDataChannel property readyState returns an enum of type RTCDataChannelState which indicates the state of the data channel's underlying data connection.

See Also:

RTCDataChannel.readyState - MDN, RTCDataChannel.readyState - WebRTC 1.0: Real-time Communication Between Browsers

close

public void close()

The RTCDataChannel.close() method closes the RTCDataChannel. Either peer is permitted to call this method to initiate closure of the channel.

See Also:

RTCDataChannel.close - MDN, RTCDataChannel.close() - WebRTC 1.0: Real-time Communication Between Browsers

send

public void send(@Nonnull
                 java.lang.String data)

The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

See Also:

RTCDataChannel.send - MDN, RTCDataChannel.send() - WebRTC 1.0: Real-time Communication Between Browsers

send

public void send(@Nonnull
                 Blob data)

The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

See Also:

RTCDataChannel.send - MDN, RTCDataChannel.send() - WebRTC 1.0: Real-time Communication Between Browsers

send

public void send(@Nonnull
                 ArrayBuffer data)

The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

See Also:

RTCDataChannel.send - MDN, RTCDataChannel.send() - WebRTC 1.0: Real-time Communication Between Browsers

send

public void send(@Nonnull
                 ArrayBufferView data)

The send() method of the RTCDataChannel interface sends data across the data channel to the remote peer.

See Also:

RTCDataChannel.send - MDN, RTCDataChannel.send() - WebRTC 1.0: Real-time Communication Between Browsers

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              RTCErrorEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              RTCErrorEventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              RTCErrorEventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 RTCErrorEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 RTCErrorEventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 RTCErrorEventListener callback)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             RTCDataChannelEventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             RTCDataChannelEventListener callback,
                                             boolean useCapture)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             RTCDataChannelEventListener callback)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                RTCDataChannelEventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                RTCDataChannelEventListener callback,
                                                boolean useCapture)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                RTCDataChannelEventListener callback)

addBufferedamountlowListener

@JsOverlay
public final void addBufferedamountlowListener(@Nonnull
                                                          EventListener callback,
                                                          @Nonnull
                                                          AddEventListenerOptions options)

addBufferedamountlowListener

@JsOverlay
public final void addBufferedamountlowListener(@Nonnull
                                                          EventListener callback,
                                                          boolean useCapture)

addBufferedamountlowListener

@JsOverlay
public final void addBufferedamountlowListener(@Nonnull
                                                          EventListener callback)

removeBufferedamountlowListener

@JsOverlay
public final void removeBufferedamountlowListener(@Nonnull
                                                             EventListener callback,
                                                             @Nonnull
                                                             EventListenerOptions options)

removeBufferedamountlowListener

@JsOverlay
public final void removeBufferedamountlowListener(@Nonnull
                                                             EventListener callback,
                                                             boolean useCapture)

removeBufferedamountlowListener

@JsOverlay
public final void removeBufferedamountlowListener(@Nonnull
                                                             EventListener callback)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addCloseListener

@JsOverlay
public final void addCloseListener(@Nonnull
                                              EventListener callback)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeCloseListener

@JsOverlay
public final void removeCloseListener(@Nonnull
                                                 EventListener callback)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                boolean useCapture)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   boolean useCapture)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback)