Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataChannelStats

Data channel stats.

Hierarchy

  • BaseStats
    • DataChannelStats

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _bytesReceived

_bytesReceived: number
internal

Private _bytesSent

_bytesSent: number
internal

Private _label

_label: string
internal

Private _messagesReceived

_messagesReceived: number
internal

Private _messagesSent

_messagesSent: number
internal

Private _ordered

_ordered: boolean
internal

Private _protocol

_protocol: string
internal

Private _state

_state: DataChannelState
internal

Methods

Protected deserializeProperties

  • deserializeProperties(key: string, valueJson: string): void
  • Deserializes the properties.

    Parameters

    • key: string

      The key.

    • valueJson: string

      The value in JSON format.

    Returns void

getBytesReceived

  • getBytesReceived(): number
  • Gets the number of bytes received.

    Returns number

getBytesSent

  • getBytesSent(): number
  • Gets the number of bytes sent.

    Returns number

getId

  • getId(): string
  • Gets the identifier of the object generating these stats.

    Returns string

getLabel

  • getLabel(): string
  • Gets the label.

    Returns string

getMessagesReceived

  • getMessagesReceived(): number
  • Gets the number of messages received.

    Returns number

getMessagesSent

  • getMessagesSent(): number
  • Gets the number of messages sent.

    Returns number

getOrdered

  • getOrdered(): boolean
  • Gets whether the channel is ordered.

    Returns boolean

getProtocol

  • getProtocol(): string
  • Gets the protocol.

    Returns string

getState

  • getState(): DataChannelState
  • Gets the state.

    Returns DataChannelState

getTimestamp

  • getTimestamp(): DateTime
  • Gets the timestamp when these stats were generated.

    Returns DateTime

getTypeString

  • getTypeString(): string

Protected serializeProperties

  • serializeProperties(jsonObject: Hash<string, string>): void
  • Serializes the properties.

    Parameters

    • jsonObject: Hash<string, string>

      The JSON object.

    Returns void

setBytesReceived

  • setBytesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setBytesSent

  • setBytesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setId

  • setId(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setLabel

  • setLabel(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setMessagesReceived

  • setMessagesReceived(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setMessagesSent

  • setMessagesSent(value: number): void
  • internal

    Parameters

    • value: number

    Returns void

setOrdered

  • setOrdered(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setProtocol

  • setProtocol(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setState

  • setState(value: DataChannelState): void
  • internal

    Parameters

    • value: DataChannelState

    Returns void

setTimestamp

  • setTimestamp(value: DateTime): void
  • internal

    Parameters

    • value: DateTime

    Returns void

Private stateFromString

  • stateFromString(stateString: string): DataChannelState
  • internal

    Parameters

    • stateString: string

    Returns DataChannelState

Private stateToString

  • stateToString(state: DataChannelState): string
  • internal

    Parameters

    • state: DataChannelState

    Returns string

toJson

  • toJson(): string
  • Serializes this to JSON.

    Returns string

Static fromJson

  • fromJson(dataChannelJson: string): DataChannelStats
  • Derializes data channel stats from JSON.

    Parameters

    • dataChannelJson: string

      The data channel's stats JSON.

    Returns DataChannelStats

Static fromJsonArray

  • fromJsonArray(dataChannelsJson: string): DataChannelStats[]
  • Derializes an array of data channel stats from JSON.

    Parameters

    • dataChannelsJson: string

      The data channels' stats JSON.

    Returns DataChannelStats[]

Static toJson

  • toJson(dataChannel: DataChannelStats): string
  • Serializes data channel stats to JSON.

    Parameters

    • dataChannel: DataChannelStats

      The data channel's stats.

    Returns string

Static toJsonArray

  • toJsonArray(dataChannels: DataChannelStats[]): string
  • Serializes an array of data channel stats to JSON.

    Parameters

    • dataChannels: DataChannelStats[]

      The data channels' stats.

    Returns string