MetaPid

A simple KV store for aggregating meta data about processes.

Installation

If available in Hex, the package can be installed as:

1. Add meta_pid to your list of dependencies in mix.exs:

```elixir
def deps do
  [{:meta_pid, git: "https://github.com/avvo/meta_pid.git", branch: "master"}]
end
```

1. Ensure meta_pid is started before your application:

```elixir
def application do
  [applications: [:meta_pid]]
end
```

1. Use the provided macro to define a new MetaPid registry

```elixir
defmodule MyMetaPidRegistry do
  use MetaPid, into: SomeStruct, name: :some_server_name
end
```

1. If registering under OTP, start under a supervisor, i.e.

```elixir
import Supervisor.Spec

children = [
  worker(MyMetaPidRegistry)
]

Supervisor.start_link(children, strategy: :one_for_one)
```

Example Usage

# 1) Register a pid

pid = self()
MyMetaPidRegistry.register_pid(pid)


# 2) Register a pid with some data

pid = self()
MyMetaPidRegistry.register_pid(pid, %SomeStruct{my_key: :my_value})


# 3) Update a pid's meta data

MyMetaPidRegistry.update_pid(pid, %SomeStruct{my_key: :my_new_value})


#4) Remove a pid from the registry

MyMetaPidRegistry.unregister_pid(pid)