@zeroc/ice
    Preparing search index...

    Class ConnectionMetrics

    Provides information on the data sent and received over Ice connections.

    Hierarchy (View Summary)

    Index

    Constructors

    • One-shot constructor to initialize all data members.

      Parameters

      • Optionalid: string

        The metrics identifier.

      • Optionaltotal: bigint

        The total number of objects observed by this metrics.

      • Optionalcurrent: number

        The number of objects currently observed by this metrics.

      • OptionaltotalLifetime: bigint

        The sum of the lifetime of each observed objects.

      • Optionalfailures: number

        The number of failures observed.

      • OptionalreceivedBytes: bigint

        The number of bytes received by the connection.

      • OptionalsentBytes: bigint

        The number of bytes sent by the connection.

      Returns ConnectionMetrics

    Properties

    current: number

    The number of objects currently observed by this metrics.

    failures: number

    The number of failures observed.

    id: string

    The metrics identifier.

    receivedBytes: bigint

    The number of bytes received by the connection.

    sentBytes: bigint

    The number of bytes sent by the connection.

    total: bigint

    The total number of objects observed by this metrics. This includes the number of currently observed objects and the number of objects observed in the past.

    totalLifetime: bigint

    The sum of the lifetime of each observed objects. This does not include the lifetime of objects which are currently observed, only the objects observed in the past.

    Methods

    • Obtains the sliced data associated with this instance.

      Returns SlicedData

      The sliced data if the value has a preserved-slice base class and has been sliced during unmarshaling of the value, nil otherwise.

    • Obtains the Slice type ID of the most-derived class supported by this object.

      Returns string

      The type ID.

    • The Ice run time invokes this method after unmarshaling an object's data members. This allows a subclass to override this method in order to perform additional initialization.

      Returns void

    • The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass to override this method in order to validate its data members.

      Returns void

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Ice::Object".