Search Results for

    / fm / liveswitch / DataStreamReport

    Class: DataStreamReport

    fm.liveswitch.DataStreamReport

    Data stream report.

    Hierarchy

    • Report

      ↳ DataStreamReport

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • getBytesReceived
    • getBytesSent
    • getMessagesReceived
    • getMessagesSent
    • getTypeString
    • serializeProperties
    • setBytesReceived
    • setBytesSent
    • setMessagesReceived
    • setMessagesSent
    • toJson
    • fromJson
    • processArray
    • processBoolean
    • processBooleanArray
    • processDouble
    • processFloat
    • processFloatArray
    • processInteger
    • processIntegerArray
    • processLong
    • processLongArray
    • processObject
    • processShort
    • processShortArray
    • processString
    • toJson

    Constructors

    constructor

    + new DataStreamReport(): DataStreamReport

    Initializes a new instance of the [[fm.liveswitch.dataStreamReport]] class.

    Returns: DataStreamReport

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:20

    + new DataStreamReport(stats: DataStreamStats, lastStats: DataStreamStats, eventType: string): DataStreamReport

    Parameters:

    Name Type
    stats DataStreamStats
    lastStats DataStreamStats
    eventType string

    Returns: DataStreamReport

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:27

    Methods

    deserializeProperties

    ▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

    Deserializes the properties.

    Parameters:

    Name Type Description
    key string The key.
    valueJson string The value in JSON format.

    Returns: void

    Overrides: Report

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:91


    getBytesReceived

    ▸ getBytesReceived(): number

    Gets the number of bytes received on this data stream.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:121


    getBytesSent

    ▸ getBytesSent(): number

    Gets the number of bytes sent on this data stream.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:133


    getMessagesReceived

    ▸ getMessagesReceived(): number

    Gets the number of messages received on this data stream.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:145


    getMessagesSent

    ▸ getMessagesSent(): number

    Gets the number of messages sent on this data stream.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:157


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Report

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:10


    serializeProperties

    ▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

    Serializes the properties.

    Parameters:

    Name Type Description
    jsonObject Hash<string, string> The JSON object.

    Returns: void

    Overrides: Report

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:170


    setBytesReceived

    ▸ setBytesReceived(value: number): void

    Sets the number of bytes received on this data stream.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:194


    setBytesSent

    ▸ setBytesSent(value: number): void

    Sets the number of bytes sent on this data stream.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:206


    setMessagesReceived

    ▸ setMessagesReceived(value: number): void

    Sets the number of messages received on this data stream.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:218


    setMessagesSent

    ▸ setMessagesSent(value: number): void

    Sets the number of messages sent on this data stream.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:230


    toJson

    ▸ toJson(): string

    Serializes this instance to Json.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:242


    fromJson

    ▸ StaticfromJson(dataStreamReportJson: string): DataStreamReport

    Deserializes Json to a DataStreamReport.

    Parameters:

    Name Type Description
    dataStreamReportJson string The serialized Json.

    Returns: DataStreamReport

    The deserialized DataChannelReport.

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:57


    processArray

    ▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

    Processes an array for a report.

    Type parameters:

    Name Type
    T IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValues T[] The new values.
    oldValues T[] The old values.

    Returns: T[]

    The new values, if the new values are not equivalent to the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:31


    processBoolean

    ▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

    Processes a boolean for a report.

    Parameters:

    Name Type Description
    newValue boolean The new value.
    oldValue boolean The old value.

    Returns: boolean

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:57


    processBooleanArray

    ▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

    Processes a boolean array for a report.

    Parameters:

    Name Type Description
    newValues boolean[] The new values.
    oldValues boolean[] The old values.

    Returns: boolean[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:72


    processDouble

    ▸ StaticprocessDouble(newValue: number, oldValue: number): number

    Processes a double for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:98


    processFloat

    ▸ StaticprocessFloat(newValue: number, oldValue: number): number

    Processes a float for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:113


    processFloatArray

    ▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

    Processes a float array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:128


    processInteger

    ▸ StaticprocessInteger(newValue: number, oldValue: number): number

    Processes an integer for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:154


    processIntegerArray

    ▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

    Processes a integer array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:171


    processLong

    ▸ StaticprocessLong(newValue: number, oldValue: number): number

    Processes a long for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:197


    processLongArray

    ▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

    Processes a long array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:214


    processObject

    ▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

    Processes an array for a report.

    Type parameters:

    Name Type
    T Object & IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValue T The new value.
    oldValue T The old value.

    Returns: T

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:240


    processShort

    ▸ StaticprocessShort(newValue: number, oldValue: number): number

    Processes a short for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:261


    processShortArray

    ▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

    Processes a short array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:278


    processString

    ▸ StaticprocessString(newValue: string, oldValue: string): string

    Processes a string for a report.

    Parameters:

    Name Type Description
    newValue string The new value.
    oldValue string The old value.

    Returns: string

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: Report

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:304


    toJson

    ▸ StatictoJson(dataStreamReport: DataStreamReport): string

    Serializes an instance to Json.

    Parameters:

    Name Type Description
    dataStreamReport DataStreamReport The instance to serialize.

    Returns: string

    Serialized Json.

    Defined in: Generated/TypeScript/fm.liveswitch/DataStreamReport.ts:75

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.14.6