Package: go.pact.im/x/clock/fakeclock

package fakeclock Import Path go.pact.im/x/clock/fakeclock (on go.dev) Dependency Relation imports 4 packages, and imported by 0 packages Involved Source Files #d fakeclock.go Package fakeclock provides support for testing users of a clock. Code Examples Clock_Next { var c Clock var wg sync.WaitGroup for i := 0; i < 3; i++ { i := i timer := c.Timer(time.Duration(i+1) * time.Second) wg.Add(1) go func() { defer wg.Done() defer timer.Stop() now := <-timer.C() fmt.Printf("timer %d fired at %v\n", i, now) }() } for { if _, ok := c.Next(); !ok { break } } wg.Wait() } Package-Level Type Names (total 5, in which 1 are exported) /* sort exporteds by: alphabet | popularity */ type Clock (struct) Clock is a fake clock.Scheduler interface implementation that is safe for concurrent use by multiple goroutines. Use Next, Set, Add and AddDate methods to change clock time. Advancing the time triggers scheduled events, timers and tickers. Note that the order in which events scheduled for the same time are triggered is undefined, but it is guaranteed that all events that are not after the new current time are triggered on clock time change (even if old time is equal to the next time value). The zero Clock defaults to zero time and is ready for use. Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ mu sync.Mutex now time.Time sched map[moment]time.Time Methods (total 13, in which 8 are exported) (*Clock) Add(d time.Duration) time.Time Add adds the given duration to the current time and returns the resulting clock time. It is possible to add a negative duration. It is safe for concurrent use and is a shorthand for now := c.Now().Add(d) c.Set(now) (*Clock) AddDate(years, months, days int) time.Time AddDate adds the duration corresponding to the given number of years, months and days relative to the current time and returns the resulting clock time. It is possible to add negative values. It is safe for concurrent use and is a shorthand for now := c.Now().AddDate(years, months, days) c.Set(now) (*Clock) Next() (time.Time, bool) Next advances the time to the next timer or ticker event and returns the new current time. If there are events in the past, the time is not changed. It returns false if there are no scheduled events. Otherwise it returns true and runs at least one scheduled event. (*Clock) Now() time.Time Now returns the current clock time. (*Clock) Schedule(d time.Duration, f func(now time.Time)) clock.Event Schedule implements the clock.Scheduler interface. (*Clock) Set(t time.Time) Set sets the given time to be the current clock time. It is possible to set t that is before the current clock time. (*Clock) Ticker(d time.Duration) clock.Ticker Ticker implements the clock.TickerScheduler interface. Note that the returned ticker does not adjust the time interval or drop ticks to make up for slow receivers. (*Clock) Timer(d time.Duration) clock.Timer Timer implements the clock.TimerScheduler interface. /* 5 unexporteds ... *//* 5 unexporteds: */ (*Clock) advance(now time.Time) advance runs the scheduled events for the current clock time. (*Clock) next(now time.Time) time.Time next returns the time of the next scheduled event. It returns the given now time if there are no events or some of them are in the past. (*Clock) reset(m moment, d time.Duration, dp *time.Duration) bool reset resets the given moment to run d duration after the current time. Note that reset acquires the underlying lock. Reset returns true if it rescheduled an event. (*Clock) schedule(m moment, when time.Time) bool schedule schedules the given moment to run on next clock advance. It returns true if an event was rescheduled. (*Clock) stop(m moment) bool stop removes the given moment from the set of scheduled events. It returns true if stop prevented the event from firing. Note that stop acquires the underlying lock. Implements (at least 4, all are exported) *Clock : go.pact.im/x/clock.NowScheduler *Clock : go.pact.im/x/clock.Scheduler *Clock : go.pact.im/x/clock.TickerScheduler *Clock : go.pact.im/x/clock.TimerScheduler As Outputs Of (at least 4, all are exported) func Go() *Clock func Time(now time.Time) *Clock func Unix() *Clock func Y2038(d time.Duration) *Clock /* 4 unexporteds ... *//* 4 unexporteds: */ type event (struct) event implements the moment and clock.Event interfaces. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ c *Clock f func(time.Time) Methods (total 3, in which 2 are exported) (*event) Reset(d time.Duration) bool Reset implements the clock.Event interface. (*event) Stop() bool Stop implements the clock.Event interface. /* one unexported ... *//* one unexported: */ (*event) next(now time.Time) (time.Duration, bool) next implements the moment interface. Implements (at least 2, in which 1 are exported) *event : go.pact.im/x/clock.Event /* at least one unexported ... *//* at least one unexported: */ *event : moment type moment (interface) moment represents a scheduled event. Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ ( moment) next(now time.Time) (time.Duration, bool) next returns the duration until the next occurrence of this event, or false if it is the last event. Implemented By (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ *event *ticker *timer As Inputs Of (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ func (*Clock).reset(m moment, d time.Duration, dp *time.Duration) bool func (*Clock).schedule(m moment, when time.Time) bool func (*Clock).stop(m moment) bool type ticker (struct) ticker implements the moment and clock.Ticker interfaces. Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ c *Clock ch chan time.Time d time.Duration Methods (total 4, in which 3 are exported) (*ticker) C() <-chan time.Time C implements the clock.Ticker interface. (*ticker) Reset(d time.Duration) Reset implements the clock.Ticker interface. (*ticker) Stop() Stop implements the clock.Ticker interface. /* one unexported ... *//* one unexported: */ (*ticker) next(now time.Time) (time.Duration, bool) next implements the moment interface. Implements (at least 2, in which 1 are exported) *ticker : go.pact.im/x/clock.Ticker /* at least one unexported ... *//* at least one unexported: */ *ticker : moment type timer (struct) timer implements the moment and clock.Timer interfaces. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ c *Clock ch chan time.Time Methods (total 4, in which 3 are exported) (*timer) C() <-chan time.Time C implements the clock.Timer interface. (*timer) Reset(d time.Duration) Reset implements the clock.Timer interface. (*timer) Stop() bool Stop implements the clock.Timer interface. /* one unexported ... *//* one unexported: */ (*timer) next(now time.Time) (time.Duration, bool) next implements the moment interface. Implements (at least 2, in which 1 are exported) *timer : go.pact.im/x/clock.Timer /* at least one unexported ... *//* at least one unexported: */ *timer : moment Package-Level Functions (total 4, all are exported) func Go() *Clock Go returns a clock set to the Go initial release date. That is, it is set to 2009-11-10 23:00:00 UTC. func Time(now time.Time) *Clock Time returns a clock set to the given now time. func Unix() *Clock Unix returns a clock set to the Unix epoch time. That is, it is set to 1970-01-01 00:00:00 UTC. func Y2038(d time.Duration) *Clock Y2038 returns a clock set to d duration after the Year 2038 problem time. That is, it is set to the given duration after 2038-01-19 03:14:07 UTC, the latest time that can be properly encoded as a 32-bit integer that is a number of seconds after the Unix epoch.