#include <bdlmt_eventscheduler.h>

Detailed Description

This class provides a means to change the clock that is used by a given event-scheduler to determine when events should be triggered. Constructing a EventSchedulerTestTimeSource alters the behavior of the supplied event-scheduler. After a test time-source is created, the underlying scheduler will run events according to a discrete timeline, whose successive values are determined by calls to advanceTime on the test time-source, and can be retrieved by calling now on that test time-source.

Note: Note that the "system-time" held by a test time-source does not correspond to the current system time. Test writers must use caution when scheduling absolute-time events so that they are scheduled relative to the test time-source's value for now.

See bdlmt_eventscheduler

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (EventSchedulerTestTimeSource, bslma::UsesBslmaAllocator)

	EventSchedulerTestTimeSource (EventScheduler scheduler, bslma::Allocator basicAllocator=0)

bsls::TimeInterval	advanceTime (bsls::TimeInterval amount)

bsls::TimeInterval	now () const

Constructor & Destructor Documentation

◆ EventSchedulerTestTimeSource()

bdlmt::EventSchedulerTestTimeSource::EventSchedulerTestTimeSource	(	EventScheduler *	scheduler,
		bslma::Allocator *	basicAllocator = `0`
	)

explicit

Create a test time-source object that will control the "system-time" observed by the specified scheduler. Initialize now to be an arbitrary time value.

Precondition: The behavior is undefined if any methods have previously been called on scheduler. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.; The behavior is undefined unless the supplied allocator also outlives the EventScheduler associated with this time source.

Member Function Documentation

◆ advanceTime()

bsls::TimeInterval bdlmt::EventSchedulerTestTimeSource::advanceTime ( bsls::TimeInterval amount )

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.

Precondition: The behavior is undefined unless amount is positive, and now + amount is within the range that can be represented with a bsls::TimeInterval.

◆ BSLMF_NESTED_TRAIT_DECLARATION()

bdlmt::EventSchedulerTestTimeSource::BSLMF_NESTED_TRAIT_DECLARATION	(	EventSchedulerTestTimeSource	,
		bslma::UsesBslmaAllocator
	)

◆ now()

bsls::TimeInterval bdlmt::EventSchedulerTestTimeSource::now ( ) const

Return this object's current-time value. Upon construction, this method will return an arbitrary value. Subsequent calls to advanceTime will adjust the arbitrary value forward.

The documentation for this class was generated from the following file:

bdlmt_eventscheduler.h