View Source ProcessHub.Service.Storage.Entry (ProcessHub v0.7.0)

The stored-entry value object shared by every registry storage backend.

An entry is a {key, value} tuple, or {key, value, expire_ms} when it carries a TTL. These helpers build entries on write and read their value back on read (filtering expired ones), independent of where the entry is persisted (ETS, DETS, a future remote store, ...).

Summary

Functions

build(key, value, opts)

Builds the entry for key/value, attaching an ms expiry when opts carries one.

build_many(items)

Builds entries for a batch of {key, value, opts} items (see build/3).

expired?(arg1)

Returns whether an entry has passed its TTL expiry.

now_ms()

Current time in ms since the unix epoch, the unit every expiry is expressed in.

value(arg)

Returns an entry's stored value, or nil if it has expired.

Functions

build(key, value, opts)

@spec build(term(), term(), keyword()) ::
  {term(), term()} | {term(), term(), integer()}

Builds the entry for key/value, attaching an ms expiry when opts carries one.

Two forms are accepted, :expire_at taking precedence:

:expire_at — an absolute deadline in ms since the unix epoch. Used where the deadline is derived from a replicated field (a stopped row's stopped_at), so every node computes the same value and re-writing the entry cannot extend its lifetime.
:ttl — a duration in ms, resolved against the current time.

build_many(items)

@spec build_many([{term(), term(), keyword()}]) :: [tuple()]

Builds entries for a batch of {key, value, opts} items (see build/3).

expired?(arg1)

@spec expired?(tuple()) :: boolean()

Returns whether an entry has passed its TTL expiry.

now_ms()

@spec now_ms() :: integer()

Current time in ms since the unix epoch, the unit every expiry is expressed in.

value(arg)

@spec value(tuple()) :: term() | nil

Returns an entry's stored value, or nil if it has expired.