Home Explore Help
Sign In
n4u
/
gproc
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 3227d54573
Branches Tags
gproc
/
doc
/
gproc_dist.html

gproc_dist.html 6.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module gproc_dist</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  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. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module gproc_dist</h1>
    12. 

  12. <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.
    13. 

  13. 

  14. <p><b>Behaviours:</b> <a href="gen_leader.html"><tt>gen_leader</tt></a>.</p>
    15. 

  15. <p><b>Authors:</b> Ulf Wiger (<a href="mailto:ulf.wiger@ericsson.com"><tt>ulf.wiger@ericsson.com</tt></a>).</p>
    16. 

  16. 

  17. <h2><a name="description">Description</a></h2>Extended process registry
    18. 

  18.   <p>This module implements an extended process registry</p>
    19. 

  19.   <p>For a detailed description, see gproc/doc/erlang07-wiger.pdf.</p>
    20. 

  20. <h2><a name="index">Function Index</a></h2>
    21. 

  21. <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>
    22. 

  22. <tr><td valign="top"><a href="#elected-2">elected/2</a></td><td></td></tr>
    23. 

  23. <tr><td valign="top"><a href="#from_leader-3">from_leader/3</a></td><td></td></tr>
    24. 

  24. <tr><td valign="top"><a href="#handle_DOWN-3">handle_DOWN/3</a></td><td></td></tr>
    25. 

  25. <tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
    26. 

  26. <tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
    27. 

  27. <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
    28. 

  28. <tr><td valign="top"><a href="#handle_leader_call-4">handle_leader_call/4</a></td><td></td></tr>
    29. 

  29. <tr><td valign="top"><a href="#handle_leader_cast-3">handle_leader_cast/3</a></td><td></td></tr>
    30. 

  30. <tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
    31. 

  31. <tr><td valign="top"><a href="#mreg-2">mreg/2</a></td><td></td></tr>
    32. 

  32. <tr><td valign="top"><a href="#reg-2">reg/2</a></td><td>
    33. 

  33.       Class = n  - unique name
    34. 

  34.             | p  - non-unique property
    35. 

  35.             | c  - counter
    36. 

  36.             | a  - aggregated counter
    37. 

  37.       Scope = l | g (global or local).</td></tr>
    38. 

  38. <tr><td valign="top"><a href="#set_value-2">set_value/2</a></td><td></td></tr>
    39. 

  39. <tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr>
    40. 

  40. <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td></td></tr>
    41. 

  41. <tr><td valign="top"><a href="#surrendered-3">surrendered/3</a></td><td></td></tr>
    42. 

  42. <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
    43. 

  43. <tr><td valign="top"><a href="#unreg-1">unreg/1</a></td><td></td></tr>
    44. 

  44. <tr><td valign="top"><a href="#update_counter-2">update_counter/2</a></td><td></td></tr>
    45. 

  45. </table>
    46. 

  46. 

  47. <h2><a name="functions">Function Details</a></h2>
    48. 

  48. 

  49. <h3 class="function"><a name="code_change-4">code_change/4</a></h3>
    50. 

  50. <div class="spec">
    51. 

  51. <p><tt>code_change(FromVsn, S, Extra, E) -&gt; any()</tt></p>
    52. 

  52. </div>
    53. 

  53. 

  54. <h3 class="function"><a name="elected-2">elected/2</a></h3>
    55. 

  55. <div class="spec">
    56. 

  56. <p><tt>elected(S, E) -&gt; any()</tt></p>
    57. 

  57. </div>
    58. 

  58. 

  59. <h3 class="function"><a name="from_leader-3">from_leader/3</a></h3>
    60. 

  60. <div class="spec">
    61. 

  61. <p><tt>from_leader(Ops, S, E) -&gt; any()</tt></p>
    62. 

  62. </div>
    63. 

  63. 

  64. <h3 class="function"><a name="handle_DOWN-3">handle_DOWN/3</a></h3>
    65. 

  65. <div class="spec">
    66. 

  66. <p><tt>handle_DOWN(Node, S, E) -&gt; any()</tt></p>
    67. 

  67. </div>
    68. 

  68. 

  69. <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
    70. 

  70. <div class="spec">
    71. 

  71. <p><tt>handle_call(X1, X2, S) -&gt; any()</tt></p>
    72. 

  72. </div>
    73. 

  73. 

  74. <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
    75. 

  75. <div class="spec">
    76. 

  76. <p><tt>handle_cast(Msg, S) -&gt; any()</tt></p>
    77. 

  77. </div>
    78. 

  78. 

  79. <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
    80. 

  80. <div class="spec">
    81. 

  81. <p><tt>handle_info(X1, S) -&gt; any()</tt></p>
    82. 

  82. </div>
    83. 

  83. 

  84. <h3 class="function"><a name="handle_leader_call-4">handle_leader_call/4</a></h3>
    85. 

  85. <div class="spec">
    86. 

  86. <p><tt>handle_leader_call(X1, From, S, E) -&gt; any()</tt></p>
    87. 

  87. </div>
    88. 

  88. 

  89. <h3 class="function"><a name="handle_leader_cast-3">handle_leader_cast/3</a></h3>
    90. 

  90. <div class="spec">
    91. 

  91. <p><tt>handle_leader_cast(X1, S, E) -&gt; any()</tt></p>
    92. 

  92. </div>
    93. 

  93. 

  94. <h3 class="function"><a name="init-1">init/1</a></h3>
    95. 

  95. <div class="spec">
    96. 

  96. <p><tt>init(X1) -&gt; any()</tt></p>
    97. 

  97. </div>
    98. 

  98. 

  99. <h3 class="function"><a name="mreg-2">mreg/2</a></h3>
    100. 

  100. <div class="spec">
    101. 

  101. <p><tt>mreg(T, KVL) -&gt; any()</tt></p>
    102. 

  102. </div>
    103. 

  103. 

  104. <h3 class="function"><a name="reg-2">reg/2</a></h3>
    105. 

  105. <div class="spec">
    106. 

  106. <p><tt>reg(Key, Value) -&gt; any()</tt></p>
    107. 

  107. </div><p>
    108. 

  108.       Class = n  - unique name
    109. 

  109.             | p  - non-unique property
    110. 

  110.             | c  - counter
    111. 

  111.             | a  - aggregated counter
    112. 

  112.       Scope = l | g (global or local)
    113. 

  113.   </p>
    114. 

  114. 

  115. <h3 class="function"><a name="set_value-2">set_value/2</a></h3>
    116. 

  116. <div class="spec">
    117. 

  117. <p><tt>set_value(Key, Value) -&gt; any()</tt></p>
    118. 

  118. </div>
    119. 

  119. 

  120. <h3 class="function"><a name="start_link-0">start_link/0</a></h3>
    121. 

  121. <div class="spec">
    122. 

  122. <p><tt>start_link() -&gt; any()</tt></p>
    123. 

  123. </div>
    124. 

  124. 

  125. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
    126. 

  126. <div class="spec">
    127. 

  127. <p><tt>start_link(Nodes) -&gt; any()</tt></p>
    128. 

  128. </div>
    129. 

  129. 

  130. <h3 class="function"><a name="surrendered-3">surrendered/3</a></h3>
    131. 

  131. <div class="spec">
    132. 

  132. <p><tt>surrendered(S, X2, E) -&gt; any()</tt></p>
    133. 

  133. </div>
    134. 

  134. 

  135. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
    136. 

  136. <div class="spec">
    137. 

  137. <p><tt>terminate(Reason, S) -&gt; any()</tt></p>
    138. 

  138. </div>
    139. 

  139. 

  140. <h3 class="function"><a name="unreg-1">unreg/1</a></h3>
    141. 

  141. <div class="spec">
    142. 

  142. <p><tt>unreg(Key) -&gt; any()</tt></p>
    143. 

  143. </div>
    144. 

  144. 

  145. <h3 class="function"><a name="update_counter-2">update_counter/2</a></h3>
    146. 

  146. <div class="spec">
    147. 

  147. <p><tt>update_counter(Key, Incr) -&gt; any()</tt></p>
    148. 

  148. </div>
    149. 

  149. <hr>
    150. 

  150. 

  151. <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>
    152. 

  152. <p><i>Generated by EDoc, Feb 11 2010, 05:33:38.</i></p>
    153. 

  153. </body>
    154. 

  154. </html>
    155.