RTCDataChannel Class Reference

#import <RTCDataChannel.h>

Inheritance diagram for RTCDataChannel:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(void)	- close
(BOOL)	- sendData:
(instancetype)	- NS_UNAVAILABLE
(void)	- close
(BOOL)	- sendData:
(void)	- send
(void)	- send
(void)	- send
(void)	- send
(void)	- close
(instancetype)	- initWithNativeDataChannel: [implementation]
(instancetype)	- initWithNativeDataChannel: [implementation]
Instance Methods inherited from EventTarget
void	addEventListener ([AtomicString] DOMString type, EventListener? callback, optional(AddEventListenerOptions or boolean) options=false)
void	removeEventListener ([AtomicString] DOMString type, EventListener? callback, optional(EventListenerOptions or boolean) options=false)
boolean	dispatchEvent (Event event)

Class Methods
(webrtc::DataChannelInterface::DataState)	+ nativeDataChannelStateForState: [implementation]
(webrtc::DataChannelInterface::DataState)	+ nativeDataChannelStateForState: [implementation]
(RTCDataChannelState)	+ dataChannelStateForNativeState: [implementation]
(RTCDataChannelState)	+ dataChannelStateForNativeState: [implementation]
(NSString *)	+ stringForState: [implementation]
(NSString *)	+ stringForState: [implementation]

Public Attributes
readonly attribute DOMString	label
readonly attribute boolean	ordered
readonly attribute unsigned short	maxRetransmitTime
readonly attribute unsigned short	maxRetransmits
readonly attribute DOMString	protocol
readonly attribute boolean	negotiated
readonly attribute unsigned short	id
readonly attribute DOMString	readyState
readonly attribute unsigned long	bufferedAmount
attribute DOMString	binaryType
attribute EventHandler	onopen
attribute EventHandler	onerror
attribute EventHandler	onclose
attribute EventHandler	onmessage

Properties
NSString *	label
BOOL isReliable	DEPRECATED_ATTRIBUTE
BOOL	isOrdered
NSUInteger maxRetransmitTime	DEPRECATED_ATTRIBUTE
uint16_t	maxPacketLifeTime
uint16_t	maxRetransmits
NSString *	protocol
BOOL	isNegotiated
NSInteger streamId	DEPRECATED_ATTRIBUTE
int	channelId
RTCDataChannelState	readyState
uint64_t	bufferedAmount
id< RTCDataChannelDelegate >	delegate

Method Documentation

close() [1/3]

- (void) close

close() [2/3]

- (void) close

Closes the data channel.

close() [3/3]

- (void) close

Closes the data channel.

dataChannelStateForNativeState:() [1/2]

+ (RTCDataChannelState) dataChannelStateForNativeState: (webrtc::DataChannelInterface::DataState)  nativeState

implementation

dataChannelStateForNativeState:() [2/2]

+ (RTCDataChannelState) dataChannelStateForNativeState: (webrtc::DataChannelInterface::DataState)  nativeState

implementation

initWithNativeDataChannel:() [1/2]

- (instancetype) initWithNativeDataChannel: (rtc::scoped_refptr< webrtc::DataChannelInterface >)  NS_DESIGNATED_INITIALIZER

implementation

Initialize an RTCDataChannel from a native DataChannelInterface.

initWithNativeDataChannel:() [2/2]

- (instancetype) initWithNativeDataChannel: (rtc::scoped_refptr< webrtc::DataChannelInterface >)  NS_DESIGNATED_INITIALIZER

implementation

Initialize an RTCDataChannel from a native DataChannelInterface.

nativeDataChannelStateForState:() [1/2]

+ DataChannelInterface: (RTCDataChannelState)  state

implementation

nativeDataChannelStateForState:() [2/2]

+ DataChannelInterface: (RTCDataChannelState)  state

implementation

NS_UNAVAILABLE() [1/2]

- (instancetype) NS_UNAVAILABLE

NS_UNAVAILABLE() [2/2]

- (instancetype) NS_UNAVAILABLE

send() [1/4]

- (void) send

(ArrayBuffer)

data

send() [2/4]

- (void) send

(ArrayBufferView)

data

send() [3/4]

- (void) send

(Blob)

data

send() [4/4]

- (void) send

(DOMString)

data

sendData:() [1/2]

- (BOOL) sendData:

(RTCDataBuffer *)

data

Attempt to send |data| on this data channel's underlying data transport.

sendData:() [2/2]

- (BOOL) sendData:

(RTCDataBuffer *)

data

Attempt to send |data| on this data channel's underlying data transport.

stringForState:() [1/2]

+ (NSString *) stringForState: (RTCDataChannelState)  state

implementation

stringForState:() [2/2]

+ (NSString *) stringForState: (RTCDataChannelState)  state

implementation

Member Data Documentation

binaryType

- (attribute DOMString) binaryType

bufferedAmount

- (readonly attribute unsigned long) bufferedAmount

id

- (readonly attribute unsigned short) id

label

- (readonly attribute DOMString) label

maxRetransmits

- (readonly attribute unsigned short) maxRetransmits

maxRetransmitTime

- (NSUInteger) maxRetransmitTime

negotiated

- (readonly attribute boolean) negotiated

onclose

- (attribute EventHandler) onclose

onerror

- (attribute EventHandler) onerror

onmessage

- (attribute EventHandler) onmessage

onopen

- (attribute EventHandler) onopen

ordered

- (readonly attribute boolean) ordered

protocol

- (readonly attribute DOMString) protocol

readyState

- (readonly attribute DOMString) readyState

Property Documentation

bufferedAmount

- (uint64_t) bufferedAmount

readnonatomicassign

The number of bytes of application data that have been queued using |sendData:| but that have not yet been transmitted to the network.

channelId

- (int) channelId

readnonatomicassign

The identifier for this data channel.

delegate

- (id< RTCDataChannelDelegate >) delegate

readwritenonatomicweak

The delegate for this data channel.

DEPRECATED_ATTRIBUTE [1/3]

- (NSInteger streamId) DEPRECATED_ATTRIBUTE

readnonatomicassign

Whether the data channel can send messages in unreliable mode.

Deprecated. Use maxPacketLifeTime.

Deprecated. Use channelId.

DEPRECATED_ATTRIBUTE [2/3]

- (NSUInteger maxRetransmitTime) DEPRECATED_ATTRIBUTE

readnonatomicassign

Deprecated. Use maxPacketLifeTime.

DEPRECATED_ATTRIBUTE [3/3]

- (NSInteger streamId) DEPRECATED_ATTRIBUTE

readnonatomicassign

Deprecated. Use channelId.

isNegotiated

- (BOOL) isNegotiated

readnonatomicassign

Returns whether this data channel was negotiated by the application or not.

isOrdered

- (BOOL) isOrdered

readnonatomicassign

Returns whether this data channel is ordered or not.

label

- (NSString *) label

readnonatomicassign

A label that can be used to distinguish this data channel from other data channel objects.

maxPacketLifeTime

- (uint16_t) maxPacketLifeTime

readnonatomicassign

The length of the time window (in milliseconds) during which transmissions and retransmissions may occur in unreliable mode.

maxRetransmits

- (uint16_t) maxRetransmits

readnonatomicassign

The maximum number of retransmissions that are attempted in unreliable mode.

protocol

- (NSString *) protocol

readnonatomicassign

The name of the sub-protocol used with this data channel, if any. Otherwise this returns an empty string.

readyState

- (RTCDataChannelState) readyState

readnonatomicassign

The state of the data channel.

---

The documentation for this class was generated from the following files:

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/sdk/objc/Framework/Headers/WebRTC/RTCDataChannel.h
• Source/WebCore/Modules/mediastream/RTCDataChannel.idl
• Source/ThirdParty/libwebrtc/Source/webrtc/sdk/objc/Framework/Classes/RTCDataChannel.mm