go.temporal.io/server/common/contextutil/deadline.go

39 LOC · 15 covered · 24 uncovered · 7 ranges · 370 concepts · 6 introducers · 229 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.

1 package contextutil
2
3 import (
4 "context"
5 "time"
6 )
7
8 var noop = func() {}
9
10 // WithDeadlineBuffer returns a child context with a deadline that ensures that at least buffer
11 // amount of time remains after the child deadline expires and before the parent deadline expires.
12 // The returned context timeout is therefore <= the requested timeout. If the parent deadline itself
13 // does not allow buffer amount of time, then the returned context deadline expires immediately. Use
14 // this method to create child context when the child cannot use all of parent's deadline but
15 // instead there is a need to leave some time for parent to do some post-work.
16 func WithDeadlineBuffer(
17 parent context.Context,
18 timeout time.Duration,
19 buffer time.Duration,
20 > ) (context.Context, context.CancelFunc) { deadline.go ×1
21 > if parent.Err() != nil {
22 > return parent, noop deadline.go ×1
23 > }
24
25 > parentDeadline, parentHasDeadline := parent.Deadline() deadline.go ×1
26 >
27 > if !parentHasDeadline {
28 > // No parent deadline, so buffer is available to parent after child deadline expiry. deadline.go ×1
29 > return context.WithTimeout(parent, timeout)
30 > }
31
32 // If parent deadline itself does not allow buffer then set child timeout to zero. Otherwise
33 // compute child deadline such that at least buffer remains after it and before parent deadline.
34 > remaining := time.Until(parentDeadline) - buffer deadline.go ×2
35 > if remaining < timeout {
36 > timeout = max(0, remaining) deadline.go ×1
37 > }
38 > return context.WithTimeout(parent, timeout) deadline.go ×2
39 }