[#BloombergLP-bdlmt-EventSchedulerTestTimeSource-advanceTime]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/EventSchedulerTestTimeSource.adoc[EventSchedulerTestTimeSource]::advanceTime
:relfileprefix: ../../../
:mrdocs:

Advance the test clock and dispatch due events.

== Synopsis

Declared in `<bdlmt_eventscheduler.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval]
advanceTime(xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] amount);
----

== Description

Advance this object's current‐time value by the specified `amount` of time, notify the scheduler that the time has changed, and wait for the scheduler to process the events triggered by this change in time. Return the updated current‐time value. The behavior is undefined unless `amount` is positive, and `now + amount` is within the range that can be represented with a `bsls::TimeInterval`.

== Return Value

the updated current‐time value

== Parameters

[cols="1,4"]
|===
| Name| Description
| *amount*
| positive interval by which to advance the test clock
|===


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