@zeroc/ice
    Preparing search index...

    Class SubscriberMetrics

    Provides information about IceStorm subscribers.

    The Slice compiler generated this class from Slice class ::IceMX::SubscriberMetrics.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    current delivered failures id outstanding queued total totalLifetime

    Methods

    ice_getSlicedData ice_id ice_postUnmarshal ice_preMarshal ice_staticId

    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 lifetimes of each observed object.

      • Optionalfailures: number

        The number of failures observed.

      • Optionalqueued: number

        The number of queued events.

      • Optionaloutstanding: number

        The number of outstanding events.

      • Optionaldelivered: bigint

        The number of delivered events.

      Returns SubscriberMetrics

    Properties

    current: number

    The number of objects currently observed by this metrics.

    delivered: bigint

    The number of delivered events.

    failures: number

    The number of failures observed.

    id: string

    The metrics identifier.

    outstanding: number

    The number of outstanding events.

    queued: number

    The number of queued events.

    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 lifetimes of each observed object. This does not include the lifetimes of objects which are currently observed, only the objects observed in the past.

    Methods

    • Obtains the sliced data associated with this instance.

      Returns SlicedData | null

      The sliced data if this value was sliced during unmarshaling, null otherwise. Unknown slices are preserved only when the sender uses the sliced format.

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

      Returns string

      The type ID.

    • The Ice runtime 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 runtime 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".

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods