Permalink
Browse files

docs rebuilt with new edown

  • Loading branch information...
1 parent 9a4e0c9 commit 53f97bd762566dba3fbfd77d28afac4fdcb50496 @uwiger uwiger committed with Jun 6, 2012
Showing with 171 additions and 497 deletions.
  1. +115 −291 doc/gproc.md
  2. +0 −10 doc/gproc_app.md
  3. +3 −73 doc/gproc_dist.md
  4. +0 −6 doc/gproc_info.md
  5. +0 −6 doc/gproc_init.md
  6. +0 −40 doc/gproc_lib.md
  7. +6 −14 doc/gproc_monitor.md
  8. +47 −47 doc/gproc_ps.md
  9. +0 −10 doc/gproc_sup.md
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -5,10 +5,6 @@
* [Function Details](#functions)
-
-
-
-
__Behaviours:__ [`application`](application.md).<a name="index"></a>
##Function Index##
@@ -26,25 +22,19 @@ __Behaviours:__ [`application`](application.md).<a name="index"></a>
###start/0##
-
-
`start() -> any()`
<a name="start-2"></a>
###start/2##
-
-
`start(Type, StartArgs) -> any()`
<a name="stop-1"></a>
###stop/1##
-
-
`stop(State) -> any()`
View
@@ -8,9 +8,7 @@
Extended process registry.
-
-
-__Behaviours:__ [`gen_leader`](/Users/uwiger/FL/git/gen_leader/doc/gen_leader.md).
+__Behaviours:__ [`gen_leader`](/Users/uwiger/tmp/rebar_edoc/gproc/deps/gen_leader/doc/gen_leader.md).
__Authors:__ Ulf Wiger ([`ulf@wiger.net`](mailto:ulf@wiger.net)).<a name="description"></a>
@@ -42,179 +40,137 @@ Scope = l | g (global or local).</td></tr><tr><td valign="top"><a href="#reg_sha
###code_change/4##
-
-
`code_change(FromVsn, S, Extra, E) -> any()`
<a name="elected-2"></a>
###elected/2##
-
-
`elected(S, E) -> any()`
<a name="elected-3"></a>
###elected/3##
-
-
`elected(S, E, Node) -> any()`
<a name="from_leader-3"></a>
###from_leader/3##
-
-
`from_leader(Ops, S, E) -> any()`
<a name="get_leader-0"></a>
###get_leader/0##
-
-
<pre>get_leader() -&gt; node()</pre>
<br></br>
-
-
Returns the node of the current gproc leader.<a name="give_away-2"></a>
###give_away/2##
-
-
`give_away(Key, To) -> any()`
<a name="handle_DOWN-3"></a>
###handle_DOWN/3##
-
-
`handle_DOWN(Node, S, E) -> any()`
<a name="handle_call-4"></a>
###handle_call/4##
-
-
`handle_call(X1, X2, S, E) -> any()`
<a name="handle_cast-3"></a>
###handle_cast/3##
-
-
`handle_cast(Msg, S, X3) -> any()`
<a name="handle_info-2"></a>
###handle_info/2##
-
-
`handle_info(X1, S) -> any()`
<a name="handle_leader_call-4"></a>
###handle_leader_call/4##
-
-
`handle_leader_call(X1, From, State, E) -> any()`
<a name="handle_leader_cast-3"></a>
###handle_leader_cast/3##
-
-
`handle_leader_cast(X1, S, E) -> any()`
<a name="init-1"></a>
###init/1##
-
-
`init(Opts) -> any()`
<a name="leader_call-1"></a>
###leader_call/1##
-
-
`leader_call(Req) -> any()`
<a name="leader_cast-1"></a>
###leader_cast/1##
-
-
`leader_cast(Msg) -> any()`
<a name="mreg-2"></a>
###mreg/2##
-
-
`mreg(T, KVL) -> any()`
<a name="munreg-2"></a>
###munreg/2##
-
-
`munreg(T, Keys) -> any()`
<a name="reg-1"></a>
###reg/1##
-
-
`reg(Key) -> any()`
<a name="reg-2"></a>
###reg/2##
-
-
`reg(Key, Value) -> any()`
-
-
Class = n - unique name
| p - non-unique property
| c - counter
@@ -224,71 +180,57 @@ Scope = l | g (global or local)<a name="reg_shared-2"></a>
###reg_shared/2##
-
-
`reg_shared(Key, Value) -> any()`
<a name="reset_counter-1"></a>
###reset_counter/1##
-
-
`reset_counter(Key) -> any()`
<a name="set_value-2"></a>
###set_value/2##
-
-
`set_value(Key, Value) -> any()`
<a name="start_link-0"></a>
###start_link/0##
-
-
`start_link() -> any()`
<a name="start_link-1"></a>
###start_link/1##
-
-
`start_link(Nodes) -> any()`
<a name="surrendered-3"></a>
###surrendered/3##
-
-
`surrendered(S, X2, E) -> any()`
<a name="sync-0"></a>
###sync/0##
-
-
<pre>sync() -&gt; true</pre>
<br></br>
+Synchronize with the gproc leader
-
-Synchronize with the gproc leaderThis function can be used to ensure that data has been replicated from the
+This function can be used to ensure that data has been replicated from the
leader to the current node. It does so by asking the leader to ping all
live participating nodes. The call will return `true` when all these nodes
have either responded or died. In the special case where the leader dies
@@ -300,52 +242,40 @@ the leader died.)<a name="terminate-2"></a>
###terminate/2##
-
-
`terminate(Reason, S) -> any()`
<a name="unreg-1"></a>
###unreg/1##
-
-
`unreg(Key) -> any()`
<a name="unreg_shared-1"></a>
###unreg_shared/1##
-
-
`unreg_shared(Key) -> any()`
<a name="update_counter-2"></a>
###update_counter/2##
-
-
`update_counter(Key, Incr) -> any()`
<a name="update_counters-1"></a>
###update_counters/1##
-
-
`update_counters(List) -> any()`
<a name="update_shared_counter-2"></a>
###update_shared_counter/2##
-
-
`update_shared_counter(Key, Incr) -> any()`
View
@@ -5,10 +5,6 @@
* [Function Details](#functions)
-
-
-
-
__Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).<a name="index"></a>
##Function Index##
@@ -26,8 +22,6 @@ __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erla
###i/0##
-
-
<pre>i() -&gt; ok</pre>
<br></br>
Oops, something went wrong.

0 comments on commit 53f97bd

Please sign in to comment.