Core LibraryalphaAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

struct libtmux-elixir latest

Deadline

A node-local monotonic deadline shared by every stage of an operation.

Source and package
Qualified name
LibTmux.Deadline
Module
LibTmux
Package
libtmux
Source
lib/libtmux/deadline.ex
struct LibTmux.Deadline

Description#

Construct it once at admission. Passing it between stages preserves the original budget; it is not a portable timestamp or a wire value.

Discussed in Execution ownership

Members4#

  • new/2 function Creates a deadline from a positive millisecond budget.
  • option/0: option() :: {:now, integer()} typealias An optional node-local monotonic clock sample in milliseconds, used instead of sampling the current clock.
  • remaining/2 function Returns the remaining milliseconds, clamped to zero after expiry.
  • t/0 typealias A node-local monotonic millisecond cutoff. Share it between stages; never serialize it as a portable deadline.
Esc

Type to search.

Reference preview Open reference