Struct hdrhistogram::sync::Recorder

pub struct Recorder<C: Counter> { /* private fields */ }

A write-only handle to a SyncHistogram.

This handle allows you to record samples from multiple threads, each with its own Recorder, concurrently. Writes to a Recorder are wait-free and scalable except for when the SyncHistogram initiates a phase shift. During a phase shift, the next write on each associated Recorder merges its results into a shared Histogram that is then made available to the SyncHistogram once the phase shift completes. Phase shifts should also be relatively cheap for writers, as they mainly need to perform a channel send on an unbounded, lock-free channel.

An idle Recorder will hold up a phase shift indefinitely, or until it times out (is using SyncHistogram::refresh_timeout. If a Recorder will remain idle for extended periods of time, it should call Recorder::idle, which will tell the reader not to wait for this particular writer.

When a Recorder is dropped, all samples are made visible to the next SyncHistogram::refresh.

Implementations

impl<C: Counter> Recorder<C>

pub fn idle(&mut self) -> IdleRecorderGuard<'_, C>

Call this method if the Recorder will be idle for a while.

Until the returned guard is dropped, the associated SyncHistogram will not wait for this recorder on a phase shift.

pub fn into_idle(self) -> IdleRecorder<Self, C>

Mark this Recorder as inactive.

Until the returned guard is consumed, either by calling IdleRecorder::activate or by dropping it, the associated SyncHistogram will not wait for this recorder on a phase shift.

pub fn add<B: Borrow<Histogram<C>>>(
    &mut self,
    source: B
) -> Result<(), AdditionError>

See Histogram::add.

pub fn add_correct<B: Borrow<Histogram<C>>>(
    &mut self,
    source: B,
    interval: u64
) -> Result<(), RecordError>

See Histogram::add_correct.

pub fn subtract<B: Borrow<Histogram<C>>>(
    &mut self,
    subtrahend: B
) -> Result<(), SubtractionError>

See Histogram::subtract.

pub fn record(&mut self, value: u64) -> Result<(), RecordError>

See Histogram::record.

pub fn saturating_record(&mut self, value: u64)

See Histogram::saturating_record.

pub fn record_n(&mut self, value: u64, count: C) -> Result<(), RecordError>

See Histogram::record_n.

pub fn saturating_record_n(&mut self, value: u64, count: C)

See Histogram::saturating_record_n.

pub fn record_correct(
    &mut self,
    value: u64,
    interval: u64
) -> Result<(), RecordError>

See Histogram::record_correct.

pub fn record_n_correct(
    &mut self,
    value: u64,
    count: C,
    interval: u64
) -> Result<(), RecordError>

See Histogram::record_n_correct.

Trait Implementations

impl<C: Counter> AddAssign<u64> for Recorder<C>

fn add_assign(&mut self, value: u64)

Performs the += operation.

impl<C: Counter> Clone for Recorder<C>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug + Counter> Debug for Recorder<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: Counter> Drop for Recorder<C>

fn drop(&mut self)

Executes the destructor for this type.