[#BloombergLP-balm-PublicationScheduler-setDefaultSchedule]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/PublicationScheduler.adoc[PublicationScheduler]::setDefaultSchedule
:relfileprefix: ../../../
:mrdocs:

Set the default publication interval to the specified `interval`&period;

== Synopsis

Declared in `&lt;balm&lowbar;publicationscheduler&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
setDefaultSchedule(xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& interval);
----

== Description

Set, to the specified `interval`, the default interval for metrics to be periodically published using the `MetricsManager` supplied at construction&period; This method schedules every metric category not given a individual schedule (using `scheduleCategory`), to be published periodically until that category is either given an individual schedule, or the default schedule is canceled (using either `clearDefaultSchedule` or `cancelAllPublications`)&period; If a default publication has _already_ been scheduled, change its schedule to `interval`&semi; any previously scheduled publication is either canceled or completed (atomically) before rescheduling&period; If the default publication is rescheduled with the same `interval` as it is currently scheduled, this operation has no effect&period; The behavior is undefined unless `bsls&colon;&colon;TimeInterval(0, 0) &lt; interval`&period; Note that, to exclude a category from any publication, clients can disable the category using the `MetricsManager` object supplied at construction&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *interval*
| default periodic publication interval
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
