… | |
… | |
83 | |
83 | |
84 | Nodes are either public (have one or more listening ports) or private |
84 | Nodes are either public (have one or more listening ports) or private |
85 | (no listening ports). Private nodes cannot talk to other private nodes |
85 | (no listening ports). Private nodes cannot talk to other private nodes |
86 | currently. |
86 | currently. |
87 | |
87 | |
88 | =item node ID - C<[a-za-Z0-9_\-.:]+> |
88 | =item node ID - C<[A-Z_][a-zA-Z0-9_\-.:]*> |
89 | |
89 | |
90 | A node ID is a string that uniquely identifies the node within a |
90 | A node ID is a string that uniquely identifies the node within a |
91 | network. Depending on the configuration used, node IDs can look like a |
91 | network. Depending on the configuration used, node IDs can look like a |
92 | hostname, a hostname and a port, or a random string. AnyEvent::MP itself |
92 | hostname, a hostname and a port, or a random string. AnyEvent::MP itself |
93 | doesn't interpret node IDs in any way. |
93 | doesn't interpret node IDs in any way. |
… | |
… | |
97 | Nodes can only talk to each other by creating some kind of connection to |
97 | Nodes can only talk to each other by creating some kind of connection to |
98 | each other. To do this, nodes should listen on one or more local transport |
98 | each other. To do this, nodes should listen on one or more local transport |
99 | endpoints - binds. Currently, only standard C<ip:port> specifications can |
99 | endpoints - binds. Currently, only standard C<ip:port> specifications can |
100 | be used, which specify TCP ports to listen on. |
100 | be used, which specify TCP ports to listen on. |
101 | |
101 | |
102 | =item seeds - C<host:port> |
102 | =item seed nodes |
103 | |
103 | |
104 | When a node starts, it knows nothing about the network. To teach the node |
104 | When a node starts, it knows nothing about the network. To teach the node |
105 | about the network it first has to contact some other node within the |
105 | about the network it first has to contact some other node within the |
106 | network. This node is called a seed. |
106 | network. This node is called a seed. |
107 | |
107 | |
108 | Seeds are transport endpoint(s) of as many nodes as one wants. Those nodes |
108 | Apart from the fact that other nodes know them as seed nodes and they have |
|
|
109 | to have fixed listening addresses, seed nodes are perfectly normal nodes - |
|
|
110 | any node can function as a seed node for others. |
|
|
111 | |
|
|
112 | In addition to discovering the network, seed nodes are also used to |
|
|
113 | maintain the network and to connect nodes that otherwise would have |
|
|
114 | trouble connecting. They form the backbone of an AnyEvent::MP network. |
|
|
115 | |
109 | are expected to be long-running, and at least one of those should always |
116 | Seed nodes are expected to be long-running, and at least one seed node |
110 | be available. When nodes run out of connections (e.g. due to a network |
117 | should always be available. They should also be relatively responsive - a |
111 | error), they try to re-establish connections to some seednodes again to |
118 | seed node that blocks for long periods will slow down everybody else. |
112 | join the network. |
|
|
113 | |
119 | |
114 | Apart from being sued for seeding, seednodes are not special in any way - |
120 | =item seeds - C<host:port> |
115 | every public node can be a seednode. |
121 | |
|
|
122 | Seeds are transport endpoint(s) (usually a hostname/IP address and a |
|
|
123 | TCP port) of nodes thta should be used as seed nodes. |
|
|
124 | |
|
|
125 | The nodes listening on those endpoints are expected to be long-running, |
|
|
126 | and at least one of those should always be available. When nodes run out |
|
|
127 | of connections (e.g. due to a network error), they try to re-establish |
|
|
128 | connections to some seednodes again to join the network. |
116 | |
129 | |
117 | =back |
130 | =back |
118 | |
131 | |
119 | =head1 VARIABLES/FUNCTIONS |
132 | =head1 VARIABLES/FUNCTIONS |
120 | |
133 | |
… | |
… | |
621 | the package, then the package above the package and so on (e.g. |
634 | the package, then the package above the package and so on (e.g. |
622 | C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function |
635 | C<MyApp::Chat::Server>, C<MyApp::Chat>, C<MyApp>) until the function |
623 | exists or it runs out of package names. |
636 | exists or it runs out of package names. |
624 | |
637 | |
625 | The init function is then called with the newly-created port as context |
638 | The init function is then called with the newly-created port as context |
626 | object (C<$SELF>) and the C<@initdata> values as arguments. |
639 | object (C<$SELF>) and the C<@initdata> values as arguments. It I<must> |
|
|
640 | call one of the C<rcv> functions to set callbacks on C<$SELF>, otherwise |
|
|
641 | the port might not get created. |
627 | |
642 | |
628 | A common idiom is to pass a local port, immediately monitor the spawned |
643 | A common idiom is to pass a local port, immediately monitor the spawned |
629 | port, and in the remote init function, immediately monitor the passed |
644 | port, and in the remote init function, immediately monitor the passed |
630 | local port. This two-way monitoring ensures that both ports get cleaned up |
645 | local port. This two-way monitoring ensures that both ports get cleaned up |
631 | when there is a problem. |
646 | when there is a problem. |
… | |
… | |
655 | |
670 | |
656 | sub _spawn { |
671 | sub _spawn { |
657 | my $port = shift; |
672 | my $port = shift; |
658 | my $init = shift; |
673 | my $init = shift; |
659 | |
674 | |
|
|
675 | # rcv will create the actual port |
660 | local $SELF = "$NODE#$port"; |
676 | local $SELF = "$NODE#$port"; |
661 | eval { |
677 | eval { |
662 | &{ load_func $init } |
678 | &{ load_func $init } |
663 | }; |
679 | }; |
664 | _self_die if $@; |
680 | _self_die if $@; |