Documentation
¶
Overview ¶
Package clock abstracts time behind a Clock interface with a Real implementation for production and a manually advanced Fake for tests.
Why ¶
Protocol code is full of time: the signing-time skew tolerance in cms, NotNow backoff in the command queue, SCEP challenge expiry, certificate validity checks in ca and push/apns, and DDM token timestamps. Testing those paths against the wall clock is slow and flaky, so the plan of record's package layout reserves this internal package and every time-sensitive package takes a Clock. Fake is safe for concurrent use so tests can advance it while a goroutine waits.
The package has no opinion on timers beyond After; scheduling, retry policy, and deadlines belong to the callers.
References ¶
- Decision record 0006: docs/research/decisions/0006-mdm-signature-verification.md (signing-time skew)
- Decision record 0019: docs/research/decisions/0019-canonical-json-and-ddm-tokens.md (token timestamps)
- Plan of record: docs/research/implementation_plan.md (section 1, package layout; phase 2)
- Apple: https://developer.apple.com/documentation/devicemanagement/handling-notnow-status-responses
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Clock ¶
type Clock interface {
// Now returns the current time.
Now() time.Time
// Since returns the elapsed time since t.
Since(t time.Time) time.Duration
// After waits for the duration to elapse and then sends the current time
// on the returned channel.
After(d time.Duration) <-chan time.Time
}
Clock is the subset of the time package that the library depends on.
type Fake ¶
type Fake struct {
// contains filtered or unexported fields
}
Fake is a manually advanced Clock for tests. It is safe for concurrent use.
func (*Fake) After ¶
After implements Clock. The returned channel fires once Advance or Set moves the clock to or past now+d. A non-positive duration fires immediately.
Source Files