Fixed ln for modules
[rrdtool.git] / bindings / perl-shared / RRDs.pm
1 package RRDs;
2
3 use strict;
4 use vars qw(@ISA $VERSION);
5
6 @ISA = qw(DynaLoader);
7
8 require DynaLoader;
9
10 $VERSION = 1.000331;
11
12 bootstrap RRDs $VERSION;
13
14 1;
15 __END__
16
17 =head1 NAME
18
19 RRDs - Access rrdtool as a shared module
20
21 =head1 SYNOPSIS
22
23   use RRDs;
24   RRDs::error
25   RRDs::last ...
26   RRDs::info ...
27   RRDs::create ...
28   RRDs::update ...
29   RRDs::graph ...
30   RRDs::fetch ...
31   RRDs::tune ...
32
33 =head1 DESCRIPTION
34
35 =head2 Calling Sequence
36
37 This module accesses rrdtool functionality directly from within perl. The
38 arguments to the functions listed in the SYNOPSIS are explained in the regular
39 rrdtool documentation. The commandline call
40
41  rrdtool update mydemo.rrd --template in:out N:12:13
42
43 gets turned into
44
45  RRDs::update ("mydemo.rrd", "--template", "in:out", "N:12:13");
46
47 Note that
48
49  --template=in:out
50
51 is also valid.
52
53
54 =head2 Error Handling
55
56 The RRD functions will not abort your program even when they can not make
57 sense out of the arguments you fed them.
58
59 The function RRDs::error should be called to get the error status
60 after each function call. If RRDs::error does not return anything
61 then the previous function has completed its task successfully.
62
63  use RRDs;
64  RRDs::update ("mydemo.rrd","N:12:13");
65  my $ERR=RRDs::error;
66  die "ERROR while updating mydemo.rrd: $ERR\n" if $ERR;
67
68 =head2 Return Values
69
70 The functions RRDs::last, RRDs::graph, RRDs::info and RRDs::fetch return their
71 findings.
72
73 B<RRDs::last> returns a single INTEGER representing the last update time.
74
75  $lastupdate = RRDs::last ...
76
77 B<RRDs::graph> returns an pointer to an ARRAY containing the x-size and y-size of the
78 created gif and results of the PRINT arguments.
79
80  ($averages,$xsize,$ysize) = RRDs::graph ...
81  print "Gifsize: ${xsize}x${ysize}\n";
82  print "Averages: ", (join ", ", @$averages);
83
84 B<RRDs::info> returns a pointer to a hash. The keys of the hash
85 represent the property names of the rrd and the values of the hash are
86 the values of the properties.  
87
88  $hash = RRDs::info "example.rrd";
89  foreach my $key (keys %$hash){
90    print "$key = $$hash{$key}\n";
91  }
92
93 B<RRDs::fetch> is the most complex of
94 the pack regarding return values. There are 4 values. Two normal
95 integers, a pointer to an array and a pointer to a array of pointers.
96
97   my ($start,$step,$names,$data) = RRDs::fetch ... 
98   print "Start:       ", scalar localtime($start), " ($start)\n";
99   print "Step size:   $step seconds\n";
100   print "DS names:    ", join (", ", @$names)."\n";
101   print "Data points: ", $#$data + 1, "\n";
102   print "Data:\n";
103   foreach my $line (@$data) {
104     print "  ", scalar localtime($start), " ($start) ";
105     $start += $step;
106     foreach my $val (@$line) {
107       printf "%12.1f ", $val;
108     }
109     print "\n";
110   }
111
112 See the examples directory for more ways to use this extension.
113
114 =head1 AUTHOR
115
116 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
117
118 =cut