Schedule category for periodic publication at interval.

Synopsis

Declared in <balm_publicationscheduler.h>

void
scheduleCategory(
    Category const* category,
    bsls::TimeInterval const& interval);

Description

Schedule the specified category to be published periodically at the specified interval using the MetricManager supplied at construction. If category has already been scheduled, change the scheduled period to interval; any previously scheduled publication of category is either canceled or completed (atomically) prior to rescheduling. If a category is rescheduled with the same interval as it is currently scheduled, this operation has no effect. The behavior is undefined unless bsls::TimeInterval(0, 0) < interval and category is a valid address supplied by the balm::MetricRegistry owned by the MetricsManager object supplied at construction.

Parameters

Name

Description

category

category to schedule for periodic publication

interval

periodic publication interval for category

Created with MrDocs