mirror https://github.com/uwiger/gproc

Ulf Wiger 62d109a3d6 undid mistaken delete of pdf file 14 years ago
doc 62d109a3d6 undid mistaken delete of pdf file 14 years ago
ebin 98ba2d9bfa added rebar support 14 years ago
include 9d5340e024 fixes noted by @jlouis, first eunit suite, bug fixes around mreg 14 years ago
patches d0bc9d2409 restructuring 16 years ago
priv 42a9f405be minor directory cleanup 15 years ago
reference 98ba2d9bfa added rebar support 14 years ago
src f0807c90f7 make eqc test less chatty 14 years ago
.gitignore 6d26f3f42c Added gitignore 15 years ago
Makefile 95a6320b65 added 'doc' target to Makefile 14 years ago
README.md 1cb3c92dc2 added words about building docs 14 years ago
rebar f0807c90f7 make eqc test less chatty 14 years ago
rebar.config bde4651a6f rebar doc automatically builds GFM 14 years ago

README.md

Gproc - Extended Process Dictionary for Erlang

Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:

  • Use any term as a process alias
  • Register a process under several aliases
  • Non-unique properties can be registered simultaneously by many processes
  • QLC and match specification interface for efficient queries on the dictionary
  • Await registration, let's you wait until a process registers itself
  • Counters, and aggregated counters, which automatically maintain the total of all counters with a given name.
  • Global registry, with all the above functions applied to a network of nodes.

Gproc has a QuickCheck test suite, covering a fairly large part of the local gproc functionality, although none of the global registry. It requires a commercial EQC license, but rebar is smart enough to detect whether EQC is available, and if it isn't, the code in gproc_eqc.erl will be "defined away".

There is also an eunit suite in gproc.erl, but it covers only some of the most basic functions (local only). Lots more tests need to be written... some day. Contributions are most welcome.

Building Edoc

By default, ./rebar doc generates Github-flavored Markdown files. If you want to change this, remove this line from rebar.config.

{edoc_opts, [{doclet, edown_doclet}]}.