Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebRtcDataChannelBase<TDataChannel>

Data channel base properties/methods.

Type parameters

  • TDataChannel

Hierarchy

  • Dynamic
    • WebRtcDataChannelBase

Implements

  • IDataChannel<TDataChannel>

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.dataChannelBase class.

    Parameters

    • label: string

      The label.

    • ordered: boolean

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

    • subprotocol: string

      The subprotocol.

    Returns WebRtcDataChannelBase

Properties

Private __onStateChange

__onStateChange: Array<IAction1<TDataChannel>>
internal

Private __state

__state: DataChannelState
internal

Private __stateLock

__stateLock: Object
internal

Private _id

_id: string
internal

Private _label

_label: string
internal

Private _onReceive

_onReceive: IAction1<DataChannelReceiveArgs>
internal

Private _onStateChange

_onStateChange: IAction1<TDataChannel>
internal

Private _ordered

_ordered: boolean
internal

Private _subprotocol

_subprotocol: string
internal

Methods

addOnStateChange

  • addOnStateChange(value: IAction1<TDataChannel>): void
  • Adds a handler that is raised when the state changes.

    Parameters

    • value: IAction1<TDataChannel>

    Returns void

doUpdateState

  • doUpdateState(value: DataChannelState): void
  • Updates state.
    internal

    Parameters

    • value: DataChannelState

    Returns void

Private fmicelinkWebRtcDataChannelBaseInit

  • fmicelinkWebRtcDataChannelBaseInit(): void

  • Returns void

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getId

  • getId(): string
  • Gets the identifier.

    Returns string

Protected Abstract getInstance

  • getInstance(): TDataChannel
  • Gets the current instance.

    Returns TDataChannel

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getLabel

  • getLabel(): string
  • Gets the label.

    Returns string

getOnReceive

  • getOnReceive(): IAction1<DataChannelReceiveArgs>
  • Gets the callback to execute when a message is received.

    Returns IAction1<DataChannelReceiveArgs>

getOrdered

  • getOrdered(): boolean
  • Gets a value indicating whether messages will be delivered in the order they are sent.

    Returns boolean

getSerialized

  • getSerialized(): string

getState

  • getState(): DataChannelState
  • Gets the state.

    Returns DataChannelState

getSubprotocol

  • getSubprotocol(): string
  • Gets the subprotocol.

    Returns string

getTypeString

  • getTypeString(): string

Protected raiseDataBytes

  • raiseDataBytes(dataBytes: DataBuffer): void
  • Raises the OnReceive callback with data bytes.

    Parameters

    • dataBytes: DataBuffer

      The data bytes.

    Returns void

Protected raiseDataString

  • raiseDataString(dataString: string): void
  • Raises the OnReceive callback with a data string.

    Parameters

    • dataString: string

      The data string.

    Returns void

removeOnStateChange

  • removeOnStateChange(value: IAction1<TDataChannel>): void
  • Removes a handler that is raised when the state changes.

    Parameters

    • value: IAction1<TDataChannel>

    Returns void

Abstract sendDataBytes

  • sendDataBytes(dataBytes: DataBuffer): void
  • Sends some bytes.

    Parameters

    • dataBytes: DataBuffer

      The data bytes.

    Returns void

Abstract sendDataString

  • sendDataString(dataString: string): void
  • Sends a string.

    Parameters

    • dataString: string

      The data string.

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setId

  • setId(value: string): void
  • Sets the identifier.

    Parameters

    • value: string

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

Private setLabel

  • setLabel(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setOnReceive

  • setOnReceive(value: IAction1<DataChannelReceiveArgs>): void
  • Sets the callback to execute when a message is received.

    Parameters

    • value: IAction1<DataChannelReceiveArgs>

    Returns void

Private setOrdered

  • setOrdered(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

Protected setState

  • setState(value: DataChannelState): void
  • Sets the state.

    Parameters

    • value: DataChannelState

    Returns void

Private setSubprotocol

  • setSubprotocol(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.

Abstract updateInternalLock

  • updateInternalLock(): void
  • Updates internal lock.
    internal

    Returns void

Abstract updateState

  • updateState(value: DataChannelState): void
  • Updates state.
    internal

    Parameters

    • value: DataChannelState

      state

    Returns void