… | |
… | |
11 | NODE $port # returns the noderef of the port |
11 | NODE $port # returns the noderef of the port |
12 | |
12 | |
13 | $SELF # receiving/own port id in rcv callbacks |
13 | $SELF # receiving/own port id in rcv callbacks |
14 | |
14 | |
15 | # initialise the node so it can send/receive messages |
15 | # initialise the node so it can send/receive messages |
16 | initialise_node; |
16 | configure; |
17 | |
17 | |
18 | # ports are message endpoints |
18 | # ports are message endpoints |
19 | |
19 | |
20 | # sending messages |
20 | # sending messages |
21 | snd $port, type => data...; |
21 | snd $port, type => data...; |
… | |
… | |
138 | |
138 | |
139 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
139 | our $VERSION = $AnyEvent::MP::Kernel::VERSION; |
140 | |
140 | |
141 | our @EXPORT = qw( |
141 | our @EXPORT = qw( |
142 | NODE $NODE *SELF node_of after |
142 | NODE $NODE *SELF node_of after |
143 | initialise_node |
143 | configure |
144 | snd rcv mon mon_guard kil reg psub spawn |
144 | snd rcv mon mon_guard kil reg psub spawn |
145 | port |
145 | port |
146 | ); |
146 | ); |
147 | |
147 | |
148 | our $SELF; |
148 | our $SELF; |
… | |
… | |
155 | |
155 | |
156 | =item $thisnode = NODE / $NODE |
156 | =item $thisnode = NODE / $NODE |
157 | |
157 | |
158 | The C<NODE> function returns, and the C<$NODE> variable contains, the node |
158 | The C<NODE> function returns, and the C<$NODE> variable contains, the node |
159 | ID of the node running in the current process. This value is initialised by |
159 | ID of the node running in the current process. This value is initialised by |
160 | a call to C<initialise_node>. |
160 | a call to C<configure>. |
161 | |
161 | |
162 | =item $nodeid = node_of $port |
162 | =item $nodeid = node_of $port |
163 | |
163 | |
164 | Extracts and returns the node ID from a port ID or a node ID. |
164 | Extracts and returns the node ID from a port ID or a node ID. |
165 | |
165 | |
166 | =item initialise_node $profile_name, key => value... |
166 | =item configure key => value... |
167 | |
167 | |
168 | Before a node can talk to other nodes on the network (i.e. enter |
168 | Before a node can talk to other nodes on the network (i.e. enter |
169 | "distributed mode") it has to initialise itself - the minimum a node needs |
169 | "distributed mode") it has to configure itself - the minimum a node needs |
170 | to know is its own name, and optionally it should know the addresses of |
170 | to know is its own name, and optionally it should know the addresses of |
171 | some other nodes in the network to discover other nodes. |
171 | some other nodes in the network to discover other nodes. |
172 | |
172 | |
173 | This function initialises a node - it must be called exactly once (or |
173 | This function configures a node - it must be called exactly once (or |
174 | never) before calling other AnyEvent::MP functions. |
174 | never) before calling other AnyEvent::MP functions. |
175 | |
175 | |
176 | The first argument is a profile name. If it is C<undef> or missing, then |
176 | =over 4 |
177 | the current nodename will be used instead (i.e. F<uname -n>). |
|
|
178 | |
177 | |
|
|
178 | =item step 1, gathering configuration from profiles |
|
|
179 | |
179 | The function first looks up the profile in the aemp configuration (see the |
180 | The function first looks up a profile in the aemp configuration (see the |
180 | L<aemp> commandline utility). the profile is calculated as follows: |
181 | L<aemp> commandline utility). The profile name can be specified via the |
|
|
182 | named C<profile> parameter. If it is missing, then the nodename (F<uname |
|
|
183 | -n>) will be used as profile name. |
|
|
184 | |
|
|
185 | The profile data is then gathered as follows: |
181 | |
186 | |
182 | First, all remaining key => value pairs (all of which are conviniently |
187 | First, all remaining key => value pairs (all of which are conviniently |
183 | undocumented at the moment) will be used. Then they will be overwritten by |
188 | undocumented at the moment) will be interpreted as configuration |
184 | any values specified in the global default configuration (see the F<aemp> |
189 | data. Then they will be overwritten by any values specified in the global |
185 | utility), then the chain of profiles selected, if any. That means that |
190 | default configuration (see the F<aemp> utility), then the chain of |
|
|
191 | profiles chosen by the profile name (and any C<parent> attributes). |
|
|
192 | |
186 | the values specified in the profile have highest priority and the values |
193 | That means that the values specified in the profile have highest priority |
187 | specified via C<initialise_node> have lowest priority. |
194 | and the values specified directly via C<configure> have lowest priority, |
|
|
195 | and can only be used to specify defaults. |
188 | |
196 | |
189 | If the profile specifies a node ID, then this will become the node ID of |
197 | If the profile specifies a node ID, then this will become the node ID of |
190 | this process. If not, then the profile name will be used as node ID. The |
198 | this process. If not, then the profile name will be used as node ID. The |
191 | special node ID of C<anon/> will be replaced by a random node ID. |
199 | special node ID of C<anon/> will be replaced by a random node ID. |
|
|
200 | |
|
|
201 | =item step 2, bind listener sockets |
192 | |
202 | |
193 | The next step is to look up the binds in the profile, followed by binding |
203 | The next step is to look up the binds in the profile, followed by binding |
194 | aemp protocol listeners on all binds specified (it is possible and valid |
204 | aemp protocol listeners on all binds specified (it is possible and valid |
195 | to have no binds, meaning that the node cannot be contacted form the |
205 | to have no binds, meaning that the node cannot be contacted form the |
196 | outside. This means the node cannot talk to other nodes that also have no |
206 | outside. This means the node cannot talk to other nodes that also have no |
197 | binds, but it can still talk to all "normal" nodes). |
207 | binds, but it can still talk to all "normal" nodes). |
198 | |
208 | |
199 | If the profile does not specify a binds list, then a default of C<*> is |
209 | If the profile does not specify a binds list, then a default of C<*> is |
200 | used. |
210 | used, meaning the node will bind on a dynamically-assigned port on every |
|
|
211 | local IP address it finds. |
201 | |
212 | |
|
|
213 | =item step 3, connect to seed nodes |
|
|
214 | |
202 | Lastly, the seeds list from the profile is passed to the |
215 | As the last step, the seeds list from the profile is passed to the |
203 | L<AnyEvent::MP::Global> module, which will then use it to keep |
216 | L<AnyEvent::MP::Global> module, which will then use it to keep |
204 | connectivity with at least on of those seed nodes at any point in time. |
217 | connectivity with at least one node at any point in time. |
205 | |
218 | |
206 | Example: become a distributed node listening on the guessed noderef, or |
219 | =back |
207 | the one specified via C<aemp> for the current node. This should be the |
220 | |
|
|
221 | Example: become a distributed node using the locla node name as profile. |
208 | most common form of invocation for "daemon"-type nodes. |
222 | This should be the most common form of invocation for "daemon"-type nodes. |
209 | |
223 | |
210 | initialise_node; |
224 | configure |
211 | |
225 | |
212 | Example: become an anonymous node. This form is often used for commandline |
226 | Example: become an anonymous node. This form is often used for commandline |
213 | clients. |
227 | clients. |
214 | |
228 | |
215 | initialise_node "anon/"; |
229 | configure nodeid => "anon/"; |
216 | |
230 | |
217 | Example: become a distributed node. If there is no profile of the given |
231 | Example: configure a node using a profile called seed, which si suitable |
218 | name, or no binds list was specified, resolve C<localhost:4044> and bind |
232 | for a seed node as it binds on all local addresses on a fixed port (4040, |
219 | on the resulting addresses. |
233 | customary for aemp). |
220 | |
234 | |
221 | initialise_node "localhost:4044"; |
235 | # use the aemp commandline utility |
|
|
236 | # aemp profile seed setnodeid anon/ setbinds '*:4040' |
|
|
237 | |
|
|
238 | # then use it |
|
|
239 | configure profile => "seed"; |
|
|
240 | |
|
|
241 | # or simply use aemp from the shell again: |
|
|
242 | # aemp run profile seed |
|
|
243 | |
|
|
244 | # or provide a nicer-to-remember nodeid |
|
|
245 | # aemp run profile seed nodeid "$(hostname)" |
222 | |
246 | |
223 | =item $SELF |
247 | =item $SELF |
224 | |
248 | |
225 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
249 | Contains the current port id while executing C<rcv> callbacks or C<psub> |
226 | blocks. |
250 | blocks. |