FMIceLinkDataChannelBase Class Reference

Inherits from FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to TDataChannel
__covariant
Declared in FMIceLinkDataChannelBase.h
FMIceLinkDataChannelBase.m

Overview

Data channel base properties/methods.

– addOnStateChange:

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void)addOnStateChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkDataChannelBase.h

– addOnStateChangeWithBlock

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void ( ^ ) ( void ( ^ ) ( id ) ))addOnStateChangeWithBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkDataChannelBase.h

– addOnStateChangeWithBlock:

Adds a handler that is raised when the [state](#//api/name/state) changes.
- (void)addOnStateChangeWithBlock:(void ( ^ ) ( id ))valueBlock

Discussion

Adds a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkDataChannelBase.h

+ dataChannelBaseWithLabel:ordered:subprotocol:

Initializes a new [instance](#//api/name/instance) of the FMIceLinkDataChannelBase`1 class.
+ (FMIceLinkDataChannelBase *)dataChannelBaseWithLabel:(NSString *)label ordered:(bool)ordered subprotocol:(NSString *)subprotocol

Parameters

label

The label.
ordered

Whether messages will be delivered in the order they are sent.
subprotocol

The subprotocol.

Discussion

Initializes a new [instance](#//api/name/instance) of the FMIceLinkDataChannelBase`1 class.

Declared In

FMIceLinkDataChannelBase.h

– id

Gets the identifier.
- (NSString *)id

Discussion

Gets the identifier.

Declared In

FMIceLinkDataChannelBase.h

– initWithLabel:ordered:subprotocol:

Initializes a new [instance](#//api/name/instance) of the FMIceLinkDataChannelBase`1 class.
- (instancetype)initWithLabel:(NSString *)label ordered:(bool)ordered subprotocol:(NSString *)subprotocol

Parameters

label

The label.
ordered

Whether messages will be delivered in the order they are sent.
subprotocol

The subprotocol.

Discussion

Initializes a new [instance](#//api/name/instance) of the FMIceLinkDataChannelBase`1 class.

Declared In

FMIceLinkDataChannelBase.h

– instance

Gets the current instance.
- (id)instance

Discussion

Gets the current instance.

Declared In

FMIceLinkDataChannelBase.h

– label

Gets the label.
- (NSString *)label

Discussion

Gets the label.

Declared In

FMIceLinkDataChannelBase.h

– onReceive

Gets the callback to execute when a message is received.
- (FMIceLinkAction1 *)onReceive

Discussion

Gets the callback to execute when a message is received.

Declared In

FMIceLinkDataChannelBase.h

– ordered

Gets a value indicating whether messages will be delivered in the order they are sent.
- (bool)ordered

Discussion

Gets a value indicating whether messages will be delivered in the order they are sent.

Declared In

FMIceLinkDataChannelBase.h

– raiseDataBytes:

Raises the OnReceive callback with data bytes.
- (void)raiseDataBytes:(FMIceLinkDataBuffer *)dataBytes

Parameters

dataBytes

The data bytes.

Discussion

Raises the OnReceive callback with data bytes.

Declared In

FMIceLinkDataChannelBase.h

– raiseDataString:

Raises the OnReceive callback with a data string.
- (void)raiseDataString:(NSString *)dataString

Parameters

dataString

The data string.

Discussion

Raises the OnReceive callback with a data string.

Declared In

FMIceLinkDataChannelBase.h

– removeOnStateChange:

Removes a handler that is raised when the [state](#//api/name/state) changes.
- (void)removeOnStateChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the [state](#//api/name/state) changes.

Declared In

FMIceLinkDataChannelBase.h

– sendDataBytes:

Sends some bytes.
- (void)sendDataBytes:(FMIceLinkDataBuffer *)dataBytes

Parameters

dataBytes

The data bytes.

Discussion

Sends some bytes.

Declared In

FMIceLinkDataChannelBase.h

– sendDataString:

Sends a string.
- (void)sendDataString:(NSString *)dataString

Parameters

dataString

The data string.

Discussion

Sends a string.

Declared In

FMIceLinkDataChannelBase.h

– setId:

Sets the identifier.
- (void)setId:(NSString *)value

Discussion

Sets the identifier.

Declared In

FMIceLinkDataChannelBase.h

– setOnReceive:

Sets the callback to execute when a message is received.
- (void)setOnReceive:(FMIceLinkAction1 *)value

Discussion

Sets the callback to execute when a message is received.

Declared In

FMIceLinkDataChannelBase.h

– setOnReceiveBlock

Sets the callback to execute when a message is received.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkDataChannelReceiveArgs *) ))setOnReceiveBlock

Discussion

Sets the callback to execute when a message is received.

Declared In

FMIceLinkDataChannelBase.h

– setOnReceiveBlock:

Sets the callback to execute when a message is received.
- (void)setOnReceiveBlock:(void ( ^ ) ( FMIceLinkDataChannelReceiveArgs *))valueBlock

Discussion

Sets the callback to execute when a message is received.

Declared In

FMIceLinkDataChannelBase.h

– setState:

Sets the [state](#//api/name/state).
- (void)setState:(FMIceLinkDataChannelState)value

Discussion

Sets the [state](#//api/name/state).

Declared In

FMIceLinkDataChannelBase.h

– state

Gets the state.
- (FMIceLinkDataChannelState)state

Discussion

Gets the state.

Declared In

FMIceLinkDataChannelBase.h

– subprotocol

Gets the subprotocol.
- (NSString *)subprotocol

Discussion

Gets the subprotocol.

Declared In

FMIceLinkDataChannelBase.h