blob: 90c6950078e7b18853e20e2d4dd45b8a2011f54b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>rrdFile module</TITLE>
<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.0 (Linux)">
<META NAME="CREATED" CONTENT="20090209;18445600">
<META NAME="CHANGED" CONTENT="20090209;19214700">
<META NAME="Info 1" CONTENT="">
<META NAME="Info 2" CONTENT="">
<META NAME="Info 3" CONTENT="">
<META NAME="Info 4" CONTENT="">
<STYLE TYPE="text/css">
<!--
@page { margin: 0.79in }
TD P { margin-bottom: 0.08in }
H1 { margin-bottom: 0.08in }
H1.western { font-family: "Liberation Sans", sans-serif; font-size: 22pt }
P { margin-bottom: 0.08in }
H2.heading-2-western { font-family: "Liberation Serif", serif; font-size: 16pt }
TH P { margin-bottom: 0.08in }
A:link { so-language: zxx }
-->
</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H1 CLASS="western">rrdFile module</H1>
<TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2>
<TR>
<TD>
<HR>
<P>The <A HREF="../../src/lib/rrdFile.js">rrdFile Javascript
module</A> implements a set of classes that can be used to extract
information from <A HREF="http://oss.oetiker.ch/rrdtool/">RRD
archives</A> loaded as binary file objects.</P>
<HR>
</TD>
</TR>
</TABLE>
<H2 CLASS="heading-2-western">Overview</H2>
<P>The main class in this module is <A HREF="#RRDFile">RRDFile</A>.
It interprets the given the binary file object and provides methods
to decode the <A HREF="http://oss.oetiker.ch/rrdtool/">RRD</A>
information.</P>
<H2 CLASS="heading-2-western"><A NAME="RRDFile"></A>Class RRDFile</H2>
<P>This is the main class of the package. It is also the only class
the user ever needs to explicitly instantiate.</P>
<P>The RRDFile constructor has a single argument:</P>
<UL>
<LI><P>A binary file object.</P>
<P>Any object implementing an interface providing the following
methods can be used:</P>
<UL>
<LI><P>getByteAt(idx) - Return a 8 bit unsigned integer at offset
idx.</P>
<LI><P>getLongAt(idx) - Return a 32 bit unsigned integer at offset
idx.</P>
<LI><P>getDoubleAt(idx) - Return a double float at offset idx.</P>
<LI><P>getFastDoubleAt(idx) - Similar to getDoubleAt but with less
precision.</P>
<LI><P>getCStringAt(idx,maxsize) - Return a string of at most
maxsize characters that was 0-terminated in the source.</P>
</UL>
<P>The <A HREF="binaryXHR_js.html">binaryXHR module</A>, provided
with this package, provides the class <A HREF="binaryXHR_js.html#BinaryFile">BinaryFile</A>
that implements this interface.</P>
</UL>
<P>If the binary file is not a proper <A HREF="http://oss.oetiker.ch/rrdtool/">RRD
file</A>, an <A HREF="#InvalidRRD">InvalidRRD</A> exception will be
thrown.</P>
<P>This class also implements the following methods:</P>
<DIV ALIGN=RIGHT>
<TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
<COL WIDTH=51*>
<COL WIDTH=205*>
<THEAD>
<TR VALIGN=TOP>
<TH WIDTH=20%>
<P ALIGN=LEFT>Method</P>
</TH>
<TH WIDTH=80%>
<P ALIGN=LEFT>Description</P>
</TH>
</TR>
</THEAD>
<TBODY>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getMinStep()</P>
</TD>
<TD WIDTH=80%>
<P>Return the base <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#I__step__s_step__default__300_seconds_">interval
in seconds</A> that was used to feed the RRD file.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getLastUpdate()</P>
</TD>
<TD WIDTH=80%>
<P>Return the timestamp of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdlastupdate.en.html">last
update</A>.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getNrDSs()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
Sources</A> present in the RRD file.
</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getDS(n)</P>
</TD>
<TD WIDTH=80%>
<P>Return an object of type <A HREF="#RRDDS">RRDDS</A> holding
the information about the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
Source</A>.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getNrRRAs()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
Robin Archives</A> present in the RRD file.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getRRAInfo(n)</P>
</TD>
<TD WIDTH=80%>
<P>Return an object of type <A HREF="#RRDRRAInfo">RRDRRAInfo</A>
holding the information about the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
Robin Archive</A>.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getRRA(n)</P>
</TD>
<TD WIDTH=80%>
<P>Return an object of type <A HREF="#RRDRRA">RRDRRA</A> that
can be used to access the values stored in the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
Robin Archive</A>.</P>
</TD>
</TR>
</TBODY>
</TABLE>
</DIV>
<H2 CLASS="heading-2-western"><A NAME="RRDDS"></A>Class RRDDS</H2>
<P>This class implements the methods needed to access the information
about a <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">RRD
Data Source</A>.</P>
<DIV ALIGN=RIGHT>
<TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
<COL WIDTH=51*>
<COL WIDTH=205*>
<THEAD>
<TR VALIGN=TOP>
<TH WIDTH=20%>
<P ALIGN=LEFT>Method</P>
</TH>
<TH WIDTH=80%>
<P ALIGN=LEFT>Description</P>
</TH>
</TR>
</THEAD>
<TBODY>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getName()</P>
</TD>
<TD WIDTH=80%>
<P>Return the name of the data source.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getType()</P>
</TD>
<TD WIDTH=80%>
<P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">type</A>
of the data source.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getMin()</P>
</TD>
<TD ROWSPAN=2 WIDTH=80%>
<P>Return the minimum and maximum value the data source can
contain.
</P>
<P>If either is not defined, <I>undefined</I> is returned.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getMax()</P>
</TD>
</TR>
</TBODY>
</TABLE>
</DIV>
<H2 CLASS="heading-2-western"><A NAME="RRDRRAInfo"></A>Class
RRDRRAInfo</H2>
<P>This class implements the methods needed to access the information
about a <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
Robin Archive</A>.</P>
<DIV ALIGN=RIGHT>
<TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
<COL WIDTH=52*>
<COL WIDTH=204*>
<THEAD>
<TR VALIGN=TOP>
<TH WIDTH=20%>
<P ALIGN=LEFT>Method</P>
</TH>
<TH WIDTH=80%>
<P ALIGN=LEFT>Description</P>
</TH>
</TR>
</THEAD>
<TBODY>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getNrRows()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of rows in the RRA.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getStep()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of seconds between rows.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getCFName()</P>
</TD>
<TD WIDTH=80%>
<P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Consolidation
Function</A> used by the RRA.</P>
</TD>
</TR>
</TBODY>
</TABLE>
</DIV>
<H2 CLASS="heading-2-western"><A NAME="RRDRRA"></A>Class RRDRRA</H2>
<P>This class implements the methods needed to access the content of
a <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Round
Robin Archive</A>.</P>
<DIV ALIGN=RIGHT>
<TABLE WIDTH=90% BORDER=1 CELLPADDING=2 CELLSPACING=3>
<COL WIDTH=52*>
<COL WIDTH=204*>
<THEAD>
<TR VALIGN=TOP>
<TH WIDTH=20%>
<P ALIGN=LEFT>Method</P>
</TH>
<TH WIDTH=80%>
<P ALIGN=LEFT>Description</P>
</TH>
</TR>
</THEAD>
<TBODY>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getCFName()</P>
</TD>
<TD WIDTH=80%>
<P>Return the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IRRA_CF_cf_arguments">Consolidation
Function</A> used by the RRA.</P>
<P>The current implementation only supports
AVERAGE,MAXIMUM,MINIMUM and LAST.<BR>Access to elements of any
other CF is currently undefined.
</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getNrRows()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of rows in the RRA.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getNrDSs()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
Sources</A> present in the RRA.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getStep()</P>
</TD>
<TD WIDTH=80%>
<P>Return the number of seconds between rows.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getEl(r,d)</P>
</TD>
<TD WIDTH=80%>
<P>Return the value for the d-th DS in the r-th row.</P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
<P>getElFast(row,ds)</P>
</TD>
<TD WIDTH=80%>
<P>Return the low-precision value for the d-th DS in the r-th
row.</P>
</TD>
</TR>
</TBODY>
</TABLE>
</DIV>
<H2 CLASS="heading-2-western"><A NAME="InvalidRRD"></A>Exception
class InvalidRRD</H2>
<P>This is a helper exception class that can be thrown while
interpreting the binary file object.</P>
<P><BR><BR>
</P>
<TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2>
<TR>
<TD>
<HR>
<P>This module is part of the <A HREF="index.html">javascriptRRD
package</A> hosted at <A HREF="http://javascript.sourceforge.net/">http://javascript.sourceforge.net</A>.
<BR>It is licensed under the <A HREF="http://www.opensource.org/licenses/mit-license.php">MIT
license</A>.
</P>
<HR>
</TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
