Cairn.Await (cairn v0.1.3)

Mailbox helpers for awaiting Cairn messages by ref.

Summary

all_result()

collect_result()

message_stream()

ref()

ref_set()

refs()

result()

wait()

@type all_result() :: {:ok, [Cairn.Message.t()]} | {:error, :timeout}

@type collect_result() ::
  {:ok, [Cairn.Message.t()]} | {:partial, [Cairn.Message.t()], refs()}

@type message_stream() :: Enumerable.t()

@type ref() :: Cairn.Message.ref()

@type ref_set() :: MapSet.t(ref())

@type refs() :: [ref()]

@type result() :: {:ok, Cairn.Message.t()} | {:error, :timeout}

@type wait() :: non_neg_integer() | :infinity

@spec all(refs(), wait()) :: all_result()

@spec any(refs(), wait()) :: result()

@spec collect(refs(), wait()) :: collect_result()

@spec message(ref(), wait()) :: result()

@spec stream(refs(), wait()) :: message_stream()