BPXE.Registry (bpxe v0.4.0)

BPXE.Registry provides centralized abstraction for a name registry.

At the moment, it follows syn's API closely but this might change in the future.

To list used names, run mix bpxe.registry

Link to this section Summary

Link to this section Types

Specs

name() :: any()

Link to this section Functions

Specs

register(name()) :: :ok | {:error, :taken}
Link to this function

register(name, meta)

Specs

register(name(), any()) :: :ok | {:error, :taken}
register(name(), pid()) :: :ok | {:error, :taken}
Link to this function

register(name, pid, meta)

Specs

register(name(), pid(), any()) :: :ok | {:error, :taken}
Link to this function

unregister(name)

Specs

unregister(name()) :: :ok | {:error, :undefined}
Link to this function

whereis(name, options \\ [])

Specs

whereis(name(), [{:meta, false}]) :: nil | pid()
whereis(name(), [{:meta, true}]) :: nil | {pid(), any()}