1 # $Id: Pod.pm,v 1.11 2006-06-06 16:27:56 mike Exp $
11 # Just register the name
12 ZOOM::Log::mask_str("pod");
13 ZOOM::Log::mask_str("pod_unhandled");
18 ZOOM::Pod - Perl extension for handling pods of concurrent ZOOM connections
24 $pod = new ZOOM::Pod("bagel.indexdata.com/gils",
25 "bagel.indexdata.com/marc");
26 $pod->callback(ZOOM::Event::RECV_SEARCH, \&completed_search);
27 $pod->callback(ZOOM::Event::RECV_RECORD, \&got_record);
28 $pod->search_pqf("the");
30 die "$pod->wait() failed with error $err" if $err;
32 sub completed_search {
33 ($conn, undef, $rs) = @_;
34 print $conn->option("host"), ": found ", $rs->size(), " records\n";
35 $rs->records(0, 1, 0); # Queues a request for the record
40 ($conn, undef, $rs) = @_;
41 $rec = $rs->record(0);
42 print $conn->option("host"), ": got $rec = '", $rec->render(), "'\n";
48 C<ZOOM:Pod> provides an API that simplifies asynchronous programming
49 using ZOOM. A pod is a collection of asynchronous connections that
50 are run simultaneously to achieve broadcast searching and retrieval.
51 When a pod is created, a set of connections (or target-strings to
52 connect to) are specified. Thereafter, they are treated as a unit,
53 and methods for searching, option-setting, etc. that are invoked on
54 the pod are delegated to each of its members.
56 The key method on a pod is C<wait()>, which enters a loop accepting
57 and dispatching events occurring on any of the connections in the pod.
58 Unless interrupted,the loop runs until there are no more events left,
59 i.e. no searches are outstanding and no requested records have still
62 Event dispatching is done by means of callback functions, which can be
63 registered for each event. A registered callback is invoked whenever
64 a corresponding event occurs. A special callback can be nominated to
71 $pod = new ZOOM::Pod($conn1, $conn2, $conn3);
72 $pod = new ZOOM::Pod("bagel.indexdata.com/gils",
73 "bagel.indexdata.com/marc");
75 Creates a new pod containing one or more connections. Each connection
76 may be specified either by an existing C<ZOOM::Connection> object,
77 which I<must> be asynchronous; or by a ZOOM target string, in which
78 case the pod module will make the connection object itself.
80 If the constructor's first argument is a number, then it is taken as a
81 limit on the number of connections to handle at any one time. In this
82 case, the pod initially multiplexes between the first I<n>
83 connections, and brings further connections into the active subset
84 whenever already-active connections are closed.
94 die "$class with no connections" if @conn == 0;
95 my @state; # Hashrefs with application state associated with connections
96 foreach my $conn (@conn) {
98 $conn = new ZOOM::Connection($conn, 0, async => 1);
99 # The $conn object is always made, even if no there's no
100 # server. Such errors are caught later, by the _check()
116 $oldElemSet = $pod->option("elementSetName");
117 $pod->option(elementSetName => "b");
119 Sets a specified option in all the connections in a pod. Returns the
120 old value that the option had in first of the connections in the pod:
121 be aware that this value was not necessarily shared by all the members
122 of the pod ... but that is true often enough to be useful.
128 my($key, $value) = @_;
130 my $old = $this->{conn}->[0]->option($key);
131 foreach my $conn (@{ $this->{conn} }) {
132 $conn->option($key, $value);
140 $pod->callback(ZOOM::Event::RECV_SEARCH, \&completed_search);
141 $pod->callback("exception", sub { print "never mind: $@\n"; return 0 } );
143 Registers a callback to be invoked by the pod when an event happens.
144 Callback functions are invoked by C<wait()> (q.v.).
146 When registering a callback, the first argument is an event-code - one
147 of those defined in the C<ZOOM::Event> enumeration - and the second is
148 a function reference, or equivalently an inline code-fragment. It is
149 acceptable to nominate the same function as the callback for multiple
150 events, by multiple invocations of C<callback()>.
152 When an event occurs during the execution of C<wait()>, the relevant
153 callback function is called with four arguments: the connection that the
154 event happened on; a state hash-reference associated with the
155 connection; the result-set associated with the connection; and the
156 event-type (so that a single function that handles events of multiple
157 types can switch on the code where necessary). The callback function
158 can handle the event as it wishes, finishing up by returning an
159 integer. If this is zero, then C<wait()> continues as normal; if it
160 is anything else, then that value is immediately returned from
163 So a simple event-handler might look like this:
166 ($conn, $state, $rs, $event) = @_;
167 print "event $event on connection ", $conn->option("host"), "\n";
168 print "Found ", $rs->size(), " records\n"
169 if $event == ZOOM::Event::RECV_SEARCH;
173 In addition to the event-type callbacks discussed above, there is a
174 special callback, C<"exception">, which is invoked if an exception
175 occurs. This will nearly always be a ZOOM error, but this can be
176 tested using C<$exception-E<gt>isa("ZOOM::Exception")>. This callback is
177 invoked with the same arguments as described above, except that
178 instead of the event-type, the fourth argument is a copy of the
179 exception, C<$@>. Exception-handling callbacks may of course re-throw
180 the exception using C<die $exception>.
182 So a simple error-handler might look like this:
185 ($conn, $state, $rs, $exception) = @_;
186 if ($exception->isa("ZOOM::Exception")) {
187 print "Caught error $exception - continuing";
193 The C<$state> argument is a reference to an initially empty hash,
194 which the application can use as it sees fit, to store its own
195 connection-relation information. For example, an application might
196 use C<$state-E<gt>{last}> to keep a record of which was the last record
197 retrieved from the associated connection. The pod module itself does
198 not use the state hash at all, and applications are also welcome to
199 ignore it if they do not need it.
205 my($event, $sub) = @_;
207 my $old = $this->{callback}->{$event};
208 $this->{callback}->{$event} = $sub
216 $pod->search_pqf("@attr 1=1003 wedel");
218 Submits the specified query to each of the connections in a pod,
219 delegating to the same-named method of the C<ZOOM::Connection> class
220 and storing each result in a result-set object associated with the
221 connection that generated it. Returns no value: success or failure
222 must subsequently be detected by inspecting the events and exceptions
223 generated by C<wait()>ing on the pod.
226 An important simplifying assumption is that each connection can only
227 have one search active on it at a time: this allows the pod to
228 maintain the one-to-one mapping between connections and result-sets.
229 Submitting a new search on a connection before the old one has
230 completed will result in a total failure in the nature of causality,
231 and the spontaneous existence-failure of the universe. Do not do
240 foreach my $i (0..@{ $this->{conn} }-1) {
241 $this->{rs}->[$i] = $this->{conn}->[$i]->search_pqf($pqf);
248 die "$pod->wait() failed with error $err" if $err;
250 Waits for events on the connections that make up the pod, usually
251 continuing until there are no more events left and then returning
252 zero. Whenever an event occurs, a callback function is dispatched as
254 that function returns a non-zero value, then C<wait()> terminates
255 immediately, whether or not any events remain, and returns that value.
257 If an error occurs on one of the connection in the pod, then it is
258 normally thrown as a C<ZOOM::Exception>. If, however, there is a
259 special C<"exception"> callback registered, then the exception object
260 is passed to this instead. As usual, the return value of the callback
261 indicates whether C<wait()> should continue (return-value 0) or return
262 immediately (any other value). Exception-handling callbacks may of
263 course re-throw the exception.
271 while ((my $i = ZOOM::event($this->{conn})) != 0) {
272 my $conn = $this->{conn}->[$i-1];
273 my $ev = $conn->last_event();
274 my $evstr = ZOOM::event_str($ev);
275 ZOOM::Log::log("pod", "connection ", $i-1, ": event $ev ($evstr)");
280 my $sub = $this->{callback}->{exception};
281 die $@ if !defined $sub;
282 $res = &$sub($conn, $this->{state}->[$i-1],
283 $this->{rs}->[$i-1], $@);
288 my $sub = $this->{callback}->{$ev};
290 $res = &$sub($conn, $this->{state}->[$i-1],
291 $this->{rs}->[$i-1], $ev);
294 ZOOM::Log::log("pod_unhandled", "connection ", $i-1, ": unhandled event $ev ($evstr)");
304 This module generates logging messages using C<ZOOM::Log::log()>,
305 which in turn relies on the YAZ logging facilities. It uses two
316 Logs unhandled events, i.e. events of types for which no callback has
321 These logging levels can be turned on by setting the C<YAZ_LOG>
322 environment variable to C<pod,pod_unhandled>.
334 Mike Taylor, E<lt>mike@indexdata.comE<gt>
336 =head1 COPYRIGHT AND LICENCE
338 Copyright (C) 2006 by Index Data.
340 This library is free software; you can redistribute it and/or modify
341 it under the same terms as Perl itself, either Perl version 5.8.4 or,
342 at your option, any later version of Perl 5 you may have available.