gproc_dist.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html>
  3. <head>
  4. <title>Module gproc_dist</title>
  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
  6. </head>
  7. <body bgcolor="white">
  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
  9. <hr>
  10. <h1>Module gproc_dist</h1>
  11. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Extended process registry.
  12. <p><b>Behaviours:</b> <a href="gen_leader.html"><tt>gen_leader</tt></a>.</p>
  13. <p><b>Authors:</b> Ulf Wiger (<a href="mailto:ulf.wiger@ericsson.com"><tt>ulf.wiger@ericsson.com</tt></a>).</p>
  14. <h2><a name="description">Description</a></h2>Extended process registry
  15. <p>This module implements an extended process registry</p>
  16. <p>For a detailed description, see gproc/doc/erlang07-wiger.pdf.</p>
  17. <h2><a name="index">Function Index</a></h2>
  18. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td></td></tr>
  19. <tr><td valign="top"><a href="#elected-2">elected/2</a></td><td></td></tr>
  20. <tr><td valign="top"><a href="#elected-3">elected/3</a></td><td></td></tr>
  21. <tr><td valign="top"><a href="#from_leader-3">from_leader/3</a></td><td></td></tr>
  22. <tr><td valign="top"><a href="#handle_DOWN-3">handle_DOWN/3</a></td><td></td></tr>
  23. <tr><td valign="top"><a href="#handle_call-4">handle_call/4</a></td><td></td></tr>
  24. <tr><td valign="top"><a href="#handle_cast-3">handle_cast/3</a></td><td></td></tr>
  25. <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
  26. <tr><td valign="top"><a href="#handle_leader_call-4">handle_leader_call/4</a></td><td></td></tr>
  27. <tr><td valign="top"><a href="#handle_leader_cast-3">handle_leader_cast/3</a></td><td></td></tr>
  28. <tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
  29. <tr><td valign="top"><a href="#leader_call-1">leader_call/1</a></td><td></td></tr>
  30. <tr><td valign="top"><a href="#leader_cast-1">leader_cast/1</a></td><td></td></tr>
  31. <tr><td valign="top"><a href="#mreg-2">mreg/2</a></td><td></td></tr>
  32. <tr><td valign="top"><a href="#reg-1">reg/1</a></td><td></td></tr>
  33. <tr><td valign="top"><a href="#reg-2">reg/2</a></td><td>
  34. Class = n - unique name
  35. | p - non-unique property
  36. | c - counter
  37. | a - aggregated counter
  38. Scope = l | g (global or local).</td></tr>
  39. <tr><td valign="top"><a href="#set_value-2">set_value/2</a></td><td></td></tr>
  40. <tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr>
  41. <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td></td></tr>
  42. <tr><td valign="top"><a href="#surrendered-3">surrendered/3</a></td><td></td></tr>
  43. <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
  44. <tr><td valign="top"><a href="#unreg-1">unreg/1</a></td><td></td></tr>
  45. <tr><td valign="top"><a href="#update_counter-2">update_counter/2</a></td><td></td></tr>
  46. </table>
  47. <h2><a name="functions">Function Details</a></h2>
  48. <h3 class="function"><a name="code_change-4">code_change/4</a></h3>
  49. <div class="spec">
  50. <p><tt>code_change(FromVsn, S, Extra, E) -&gt; any()</tt></p>
  51. </div>
  52. <h3 class="function"><a name="elected-2">elected/2</a></h3>
  53. <div class="spec">
  54. <p><tt>elected(S, E) -&gt; any()</tt></p>
  55. </div>
  56. <h3 class="function"><a name="elected-3">elected/3</a></h3>
  57. <div class="spec">
  58. <p><tt>elected(S, E, Node) -&gt; any()</tt></p>
  59. </div>
  60. <h3 class="function"><a name="from_leader-3">from_leader/3</a></h3>
  61. <div class="spec">
  62. <p><tt>from_leader(Ops, S, E) -&gt; any()</tt></p>
  63. </div>
  64. <h3 class="function"><a name="handle_DOWN-3">handle_DOWN/3</a></h3>
  65. <div class="spec">
  66. <p><tt>handle_DOWN(Node, S, E) -&gt; any()</tt></p>
  67. </div>
  68. <h3 class="function"><a name="handle_call-4">handle_call/4</a></h3>
  69. <div class="spec">
  70. <p><tt>handle_call(X1, X2, S, X4) -&gt; any()</tt></p>
  71. </div>
  72. <h3 class="function"><a name="handle_cast-3">handle_cast/3</a></h3>
  73. <div class="spec">
  74. <p><tt>handle_cast(Msg, S, X3) -&gt; any()</tt></p>
  75. </div>
  76. <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
  77. <div class="spec">
  78. <p><tt>handle_info(X1, S) -&gt; any()</tt></p>
  79. </div>
  80. <h3 class="function"><a name="handle_leader_call-4">handle_leader_call/4</a></h3>
  81. <div class="spec">
  82. <p><tt>handle_leader_call(X1, From, S, E) -&gt; any()</tt></p>
  83. </div>
  84. <h3 class="function"><a name="handle_leader_cast-3">handle_leader_cast/3</a></h3>
  85. <div class="spec">
  86. <p><tt>handle_leader_cast(X1, S, E) -&gt; any()</tt></p>
  87. </div>
  88. <h3 class="function"><a name="init-1">init/1</a></h3>
  89. <div class="spec">
  90. <p><tt>init(Opts) -&gt; any()</tt></p>
  91. </div>
  92. <h3 class="function"><a name="leader_call-1">leader_call/1</a></h3>
  93. <div class="spec">
  94. <p><tt>leader_call(Req) -&gt; any()</tt></p>
  95. </div>
  96. <h3 class="function"><a name="leader_cast-1">leader_cast/1</a></h3>
  97. <div class="spec">
  98. <p><tt>leader_cast(Msg) -&gt; any()</tt></p>
  99. </div>
  100. <h3 class="function"><a name="mreg-2">mreg/2</a></h3>
  101. <div class="spec">
  102. <p><tt>mreg(T, KVL) -&gt; any()</tt></p>
  103. </div>
  104. <h3 class="function"><a name="reg-1">reg/1</a></h3>
  105. <div class="spec">
  106. <p><tt>reg(Key) -&gt; any()</tt></p>
  107. </div>
  108. <h3 class="function"><a name="reg-2">reg/2</a></h3>
  109. <div class="spec">
  110. <p><tt>reg(Key, Value) -&gt; any()</tt></p>
  111. </div><p>
  112. Class = n - unique name
  113. | p - non-unique property
  114. | c - counter
  115. | a - aggregated counter
  116. Scope = l | g (global or local)
  117. </p>
  118. <h3 class="function"><a name="set_value-2">set_value/2</a></h3>
  119. <div class="spec">
  120. <p><tt>set_value(Key, Value) -&gt; any()</tt></p>
  121. </div>
  122. <h3 class="function"><a name="start_link-0">start_link/0</a></h3>
  123. <div class="spec">
  124. <p><tt>start_link() -&gt; any()</tt></p>
  125. </div>
  126. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
  127. <div class="spec">
  128. <p><tt>start_link(Nodes) -&gt; any()</tt></p>
  129. </div>
  130. <h3 class="function"><a name="surrendered-3">surrendered/3</a></h3>
  131. <div class="spec">
  132. <p><tt>surrendered(S, X2, E) -&gt; any()</tt></p>
  133. </div>
  134. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
  135. <div class="spec">
  136. <p><tt>terminate(Reason, S) -&gt; any()</tt></p>
  137. </div>
  138. <h3 class="function"><a name="unreg-1">unreg/1</a></h3>
  139. <div class="spec">
  140. <p><tt>unreg(Key) -&gt; any()</tt></p>
  141. </div>
  142. <h3 class="function"><a name="update_counter-2">update_counter/2</a></h3>
  143. <div class="spec">
  144. <p><tt>update_counter(Key, Incr) -&gt; any()</tt></p>
  145. </div>
  146. <hr>
  147. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
  148. <p><i>Generated by EDoc, Sep 11 2010, 18:22:25.</i></p>
  149. </body>
  150. </html>