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

gproc.html 9.3 KB
History Raw

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

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module gproc</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</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="#first-1">first/1</a></td><td></td></tr>
    24. 

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

  25. <tr><td valign="top"><a href="#get_value-1">get_value/1</a></td><td>Read the value stored with a key registered to the current process.</td></tr>
    26. 

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

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

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

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

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

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

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

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

  34. <tr><td valign="top"><a href="#info-1">info/1</a></td><td></td></tr>
    35. 

  35. <tr><td valign="top"><a href="#info-2">info/2</a></td><td></td></tr>
    36. 

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

  37. <tr><td valign="top"><a href="#last-1">last/1</a></td><td></td></tr>
    38. 

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

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

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

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

  42.       Class = n  - unique name
    43. 

  43.             | p  - non-unique property
    44. 

  44.             | c  - counter
    45. 

  45.             | a  - aggregated counter
    46. 

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

  47. <tr><td valign="top"><a href="#select-1">select/1</a></td><td></td></tr>
    48. 

  48. <tr><td valign="top"><a href="#select-2">select/2</a></td><td></td></tr>
    49. 

  49. <tr><td valign="top"><a href="#send-2">send/2</a></td><td></td></tr>
    50. 

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

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

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

  53. <tr><td valign="top"><a href="#start_local-0">start_local/0</a></td><td></td></tr>
    54. 

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

  55. <tr><td valign="top"><a href="#table-1">table/1</a></td><td></td></tr>
    56. 

  56. <tr><td valign="top"><a href="#table-2">table/2</a></td><td></td></tr>
    57. 

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

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

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

  60. </table>
    61. 

  61. 

  62. <h2><a name="functions">Function Details</a></h2>
    63. 

  63. 

  64. <h3 class="function"><a name="code_change-4">code_change/4</a></h3>
    65. 

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

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

  67. </div>
    68. 

  68. 

  69. <h3 class="function"><a name="elected-2">elected/2</a></h3>
    70. 

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

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

  72. </div>
    73. 

  73. 

  74. <h3 class="function"><a name="first-1">first/1</a></h3>
    75. 

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

  76. <p><tt>first(Scope) -&gt; any()</tt></p>
    77. 

  77. </div>
    78. 

  78. 

  79. <h3 class="function"><a name="from_leader-3">from_leader/3</a></h3>
    80. 

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

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

  82. </div>
    83. 

  83. 

  84. <h3 class="function"><a name="get_value-1">get_value/1</a></h3>
    85. 

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

  86. <p><tt>get_value(Key) -&gt; Value</tt></p>
    87. 

  87. </div><p>Read the value stored with a key registered to the current process.
    88. 

  88.   </p>
    89. 

  89. 

  90. <h3 class="function"><a name="go_global-0">go_global/0</a></h3>
    91. 

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

  92. <p><tt>go_global() -&gt; any()</tt></p>
    93. 

  93. </div>
    94. 

  94. 

  95. <h3 class="function"><a name="go_global-1">go_global/1</a></h3>
    96. 

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

  97. <p><tt>go_global(Nodes) -&gt; any()</tt></p>
    98. 

  98. </div>
    99. 

  99. 

  100. <h3 class="function"><a name="handle_DOWN-3">handle_DOWN/3</a></h3>
    101. 

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

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

  103. </div>
    104. 

  104. 

  105. <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
    106. 

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

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

  108. </div>
    109. 

  109. 

  110. <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
    111. 

  111. <div class="spec">
    112. 

  112. <p><tt>handle_cast(X1, S) -&gt; any()</tt></p>
    113. 

  113. </div>
    114. 

  114. 

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

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

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

  118. </div>
    119. 

  119. 

  120. <h3 class="function"><a name="handle_leader_call-4">handle_leader_call/4</a></h3>
    121. 

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

  122. <p><tt>handle_leader_call(X1, From, State, E) -&gt; any()</tt></p>
    123. 

  123. </div>
    124. 

  124. 

  125. <h3 class="function"><a name="handle_leader_cast-3">handle_leader_cast/3</a></h3>
    126. 

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

  127. <p><tt>handle_leader_cast(X1, State, E) -&gt; any()</tt></p>
    128. 

  128. </div>
    129. 

  129. 

  130. <h3 class="function"><a name="info-1">info/1</a></h3>
    131. 

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

  132. <p><tt>info(Pid) -&gt; any()</tt></p>
    133. 

  133. </div>
    134. 

  134. 

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

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

  137. <p><tt>info(Pid, I) -&gt; any()</tt></p>
    138. 

  138. </div>
    139. 

  139. 

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

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

  142. <p><tt>init(X1) -&gt; any()</tt></p>
    143. 

  143. </div>
    144. 

  144. 

  145. <h3 class="function"><a name="last-1">last/1</a></h3>
    146. 

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

  147. <p><tt>last(Scope) -&gt; any()</tt></p>
    148. 

  148. </div>
    149. 

  149. 

  150. <h3 class="function"><a name="mreg-3">mreg/3</a></h3>
    151. 

  151. <div class="spec">
    152. 

  152. <p><tt>mreg(T, X2, KVL) -&gt; any()</tt></p>
    153. 

  153. </div>
    154. 

  154. 

  155. <h3 class="function"><a name="next-2">next/2</a></h3>
    156. 

  156. <div class="spec">
    157. 

  157. <p><tt>next(Scope, K) -&gt; any()</tt></p>
    158. 

  158. </div>
    159. 

  159. 

  160. <h3 class="function"><a name="prev-2">prev/2</a></h3>
    161. 

  161. <div class="spec">
    162. 

  162. <p><tt>prev(Scope, K) -&gt; any()</tt></p>
    163. 

  163. </div>
    164. 

  164. 

  165. <h3 class="function"><a name="reg-2">reg/2</a></h3>
    166. 

  166. <div class="spec">
    167. 

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

  168. </div><p>
    169. 

  169.       Class = n  - unique name
    170. 

  170.             | p  - non-unique property
    171. 

  171.             | c  - counter
    172. 

  172.             | a  - aggregated counter
    173. 

  173.       Scope = l | g (global or local)
    174. 

  174.   </p>
    175. 

  175. 

  176. <h3 class="function"><a name="select-1">select/1</a></h3>
    177. 

  177. <div class="spec">
    178. 

  178. <p><tt>select(Pat) -&gt; any()</tt></p>
    179. 

  179. </div>
    180. 

  180. 

  181. <h3 class="function"><a name="select-2">select/2</a></h3>
    182. 

  182. <div class="spec">
    183. 

  183. <p><tt>select(Scope, Pat) -&gt; any()</tt></p>
    184. 

  184. </div>
    185. 

  185. 

  186. <h3 class="function"><a name="send-2">send/2</a></h3>
    187. 

  187. <div class="spec">
    188. 

  188. <p><tt>send(Key, Msg) -&gt; any()</tt></p>
    189. 

  189. </div>
    190. 

  190. 

  191. <h3 class="function"><a name="set_value-2">set_value/2</a></h3>
    192. 

  192. <div class="spec">
    193. 

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

  194. </div>
    195. 

  195. 

  196. <h3 class="function"><a name="start_link-0">start_link/0</a></h3>
    197. 

  197. <div class="spec">
    198. 

  198. <p><tt>start_link() -&gt; any()</tt></p>
    199. 

  199. </div>
    200. 

  200. 

  201. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
    202. 

  202. <div class="spec">
    203. 

  203. <p><tt>start_link(Nodes) -&gt; any()</tt></p>
    204. 

  204. </div>
    205. 

  205. 

  206. <h3 class="function"><a name="start_local-0">start_local/0</a></h3>
    207. 

  207. <div class="spec">
    208. 

  208. <p><tt>start_local() -&gt; any()</tt></p>
    209. 

  209. </div>
    210. 

  210. 

  211. <h3 class="function"><a name="surrendered-3">surrendered/3</a></h3>
    212. 

  212. <div class="spec">
    213. 

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

  214. </div>
    215. 

  215. 

  216. <h3 class="function"><a name="table-1">table/1</a></h3>
    217. 

  217. <div class="spec">
    218. 

  218. <p><tt>table(Scope) -&gt; any()</tt></p>
    219. 

  219. </div>
    220. 

  220. 

  221. <h3 class="function"><a name="table-2">table/2</a></h3>
    222. 

  222. <div class="spec">
    223. 

  223. <p><tt>table(T, Opts) -&gt; any()</tt></p>
    224. 

  224. </div>
    225. 

  225. 

  226. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
    227. 

  227. <div class="spec">
    228. 

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

  229. </div>
    230. 

  230. 

  231. <h3 class="function"><a name="unreg-1">unreg/1</a></h3>
    232. 

  232. <div class="spec">
    233. 

  233. <p><tt>unreg(Key) -&gt; any()</tt></p>
    234. 

  234. </div>
    235. 

  235. 

  236. <h3 class="function"><a name="update_counter-2">update_counter/2</a></h3>
    237. 

  237. <div class="spec">
    238. 

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

  239. </div>
    240. 

  240. <hr>
    241. 

  241. 

  242. <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>
    243. 

  243. <p><i>Generated by EDoc, Sep 4 2008, 11:29:40.</i></p>
    244. 

  244. </body>
    245. 

  245. </html>
    246.