Merge branch 'master' of ssh://git.indexdata.com:222/home/git/pub/irspy
[irspy-moved-to-github.git] / lib / ZOOM / IRSpy / Task / Retrieve.pm
1
2 package ZOOM::IRSpy::Task::Retrieve;
3
4 use 5.008;
5 use strict;
6 use warnings;
7
8 use ZOOM::IRSpy::Task;
9 our @ISA = qw(ZOOM::IRSpy::Task);
10
11 =head1 NAME
12
13 ZOOM::IRSpy::Task::Retrieve - a searching task for IRSpy
14
15 =head1 SYNOPSIS
16
17  ## to follow
18
19 =head1 DESCRIPTION
20
21  ## to follow
22
23 =cut
24
25 sub new {
26     my $class = shift();
27     my($rs) = shift();
28     my($index0) = shift();
29
30     my $this = $class->SUPER::new(@_);
31     $this->{rs} = $rs;
32     $this->{index0} = $index0;
33     # Save initial record-syntax for render()'s benefit
34     $this->{syntax} = $this->{options}->{preferredRecordSyntax};
35
36     return $this;
37 }
38
39 sub run {
40     my $this = shift();
41
42     $this->set_options();
43
44     my $conn = $this->conn();
45     $conn->connect($conn->option("host"));
46
47     my $rs = $this->{rs};
48     my $index0 = $this->{index0};
49     $this->irspy()->log("irspy_task", $conn->option("host"),
50                         " retrieving record $index0 from $rs, rs='",
51                         $rs->option("preferredRecordSyntax"), "'");
52     $rs->records($index0, 1, 0); # requests record
53     warn "no ZOOM-C level events queued by $this"
54         if $conn->is_idle();
55
56     $this->set_options();
57 }
58
59 sub render {
60     my $this = shift();
61     my $syntax = $this->{syntax};
62     $syntax = defined $syntax ? "'$syntax'" : "undef";
63     return ref($this) . "(" . $this->{index0} . ", $syntax)";
64 }
65
66 use overload '""' => \&render;
67
68
69 =head1 SEE ALSO
70
71 ZOOM::IRSpy
72
73 =head1 AUTHOR
74
75 Mike Taylor, E<lt>mike@indexdata.comE<gt>
76
77 =head1 COPYRIGHT AND LICENSE
78
79 Copyright (C) 2006 by Index Data ApS.
80
81 This library is free software; you can redistribute it and/or modify
82 it under the same terms as Perl itself, either Perl version 5.8.7 or,
83 at your option, any later version of Perl 5 you may have available.
84
85 =cut
86
87 1;