## Uses of Interface
com.h3c.sdn.metric.TimeStampedMetric

- Packages that use TimeStampedMetric
  Package | Description
  --- | ---
  com.h3c.sdn.adm.metric | Definitions of services pertaining to the SDN core controller metering framework.
  com.h3c.sdn.metric | Fundamental classes for the SDN core controller metering framework, including the classes for various metric types that may be obtained from the framework.

- - ### Uses of TimeStampedMetric in com.h3c.sdn.adm.metric

    Methods in com.h3c.sdn.adm.metric that return TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `TimeStampedMetric` | MetricProxyService.`createMetric(CounterDescriptor descriptor)` Creates a new `TimeStampedCounter` object based upon the provided `CounterDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(GaugeDescriptor descriptor)` Creates a new `TimeStampedGauge` object based upon the provided `GaugeDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(HistogramDescriptor descriptor)` Creates a new `TimeStampedHistogram` object based upon the provided `HistogramDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(MeterDescriptor descriptor)` Creates a new `TimeStampedMeter` object based upon the provided `MeterDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(RatioGaugeDescriptor descriptor)` Creates a new `TimeStampedRatioGauge` object based upon the provided `RatioGaugeDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(RollingCounterDescriptor descriptor)` Creates a new `TimeStampedRollingCounter` object based upon the provided `RollingCounterDescriptor`.
    `TimeStampedMetric` | MetricProxyService.`createMetric(TimerDescriptor descriptor)` Creates a new `TimeStampedTimer` object based upon the provided `TimerDescriptor`.
    `TimeStampedMetric` | MetricService.`recreateMetric(String uid)` Recreates a previously existing `TimeStampedMetric` with the specified `UID`.

    Methods in com.h3c.sdn.adm.metric with parameters of type TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `void` | MetricService.`registerMetric(TimeStampedMetric toRegister)` Registers an existing `TimeStampedMetric` with the metering framework.
    `void` | MetricService.`removeMetric(TimeStampedMetric toRemove)` Removes an existing `TimeStampedMetric` object from the metering framework, essentially unregistering it so that the framework no longer processes its values.

  - ### Uses of TimeStampedMetric in com.h3c.sdn.metric

    Classes in com.h3c.sdn.metric that implement TimeStampedMetric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TimeStampedCounter` Extension of Coda Hale `Counter` class that provides an association of the `Counter` value with time stamps.
    `class` | `TimeStampedGauge` Implementation of Coda Hale `Gauge` interface that provides an association of the `Gauge` value with time stamps.
    `class` | `TimeStampedHistogram` Extension of Coda Hale `Histogram` class that provides an association of sliding time window `Histogram` values with time stamps.
    `class` | `TimeStampedMeter` Extension of Coda Hale `Meter` class that provides an association of the `Meter` value with time stamps.
    `class` | `TimeStampedRatioGauge` Extension of Coda Hale `RatioGauge` class that provides an association of the `RatioGauge` value with time stamps.
    `class` | `TimeStampedRollingCounter` A rolling (asymptotically increasing) counter metric whose value is computed as a delta between 64-bit counter snapshots over a period of time.
    `class` | `TimeStampedTimer` Extension of Coda Hale `Timer` class that provides an association of sliding time window `Timer` values with time stamps.

    Methods in com.h3c.sdn.metric that return TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `TimeStampedMetric` | MetricRegistry.`register(MetricDescriptor descriptor, TimeStampedMetric metric)` Given a `TimeStampedMetric`, registers it using the provided `MetricDescriptor`.

    Methods in com.h3c.sdn.metric that return types with arguments of type TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `Map<MetricDescriptor,TimeStampedMetric>` | MetricRegistry.`getTimeStampedMetrics()` Returns a copy of the `Map` used by the `MetricRegistry` to track registered `TimeStampedMetric`s.
    `Map<TimeStampedMetric,MetricRegistry.PersistTimes>` | MetricRegistry.`getTimeStamps()` Returns the `Map` used by the `MetricRegistry` to track when `TimeStampedMetric`s should be persisted.

    Methods in com.h3c.sdn.metric with parameters of type TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `TimeStampedMetric` | MetricRegistry.`register(MetricDescriptor descriptor, TimeStampedMetric metric)` Given a `TimeStampedMetric`, registers it using the provided `MetricDescriptor`.

    Method parameters in com.h3c.sdn.metric with type arguments of type TimeStampedMetric
    Modifier and Type | Method and Description
    --- | ---
    `void` | MetricRegistry.`registerAll(Collection<TimeStampedMetric> metrics)` Given a `Collection` of `TimeStampedMetric`s, register them.

Copyright © 2014. All Rights Reserved.