doc/librrd.3

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "librrd 3"
 127 .TH librrd 3 "2013-05-23" "1.4.8" "rrdtool"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 librrd \- RRD library functions
 134 .SH "DESCRIPTION"
 135 .IX Header "DESCRIPTION"
 136 \&\fBlibrrd\fR contains most of the functionality in \fBRRDTool\fR.  The command
 137 line utilities and language bindings are often just wrappers around the
 138 code contained in \fBlibrrd\fR.
 139 .PP
 140 This manual page documents the \fBlibrrd\fR \s-1API\s0.
 141 .PP
 142 \&\fB\s-1NOTE:\s0\fR This document is a work in progress, and should be considered
 143 incomplete as long as this warning persists.  For more information about
 144 the \fBlibrrd\fR functions, always consult the source code.
 145 .SH "CORE FUNCTIONS"
 146 .IX Header "CORE FUNCTIONS"
 147 .IP "\fBrrd_dump_cb_r(char *filename, int opt_header, rrd_output_callback_t cb, void *user)\fR" 4
 148 .IX Item "rrd_dump_cb_r(char *filename, int opt_header, rrd_output_callback_t cb, void *user)"
 149 In some situations it is necessary to get the output of \f(CW\*(C`rrd_dump\*(C'\fR without
 150 writing it to a file or the standard output. In such cases an application
 151 can ask \fBrrd_dump_cb_r\fR to call an user-defined function each time there
 152 is output to be stored somewhere. This can be used, to e.g. directly feed
 153 an \s-1XML\s0 parser with the dumped output or transfer the resulting string
 154 in memory.
 155 .Sp
 156 The arguments for \fBrrd_dump_cb_r\fR are the same as for \fBrrd_dump_opt_r\fR
 157 except that the output filename parameter is replaced by the user-defined
 158 callback function and an additional parameter for the callback function
 159 that is passed untouched, i.e. to store information about the callback state
 160 needed for the user-defined callback to function properly.
 161 .Sp
 162 Recent versions of \fBrrd_dump_opt_r\fR internally use this callback mechanism
 163 to write their output to the file provided by the user.
 164 .Sp
 165 .Vb 7
 166 \&    size_t rrd_dump_opt_cb_fileout(
 167 \&        const void *data,
 168 \&        size_t len,
 169 \&        void *user)
 170 \&    {
 171 \&        return fwrite(data, 1, len, (FILE *)user);
 172 \&    }
 173 .Ve
 174 .Sp
 175 The associated call for \fBrrd_dump_cb_r\fR looks like
 176 .Sp
 177 .Vb 2
 178 \&    res = rrd_dump_cb_r(filename, opt_header,
 179 \&        rrd_dump_opt_cb_fileout, (void *)out_file);
 180 .Ve
 181 .Sp
 182 where the last parameter specifies the file handle \fBrrd_dump_opt_cb_fileout\fR
 183 should write to. There's no specific condition for the callback to detect
 184 when it is called for the first time, nor for the last time. If you require
 185 this for initialization and cleanup you should do those tasks before and
 186 after calling \fBrrd_dump_cr_r\fR respectively.
 187 .SH "UTILITY FUNCTIONS"
 188 .IX Header "UTILITY FUNCTIONS"
 189 .IP "\fB\f(BIrrd_random()\fB\fR" 4
 190 .IX Item "rrd_random()"
 191 Generates random numbers just like \fIrandom()\fR.  This further ensures that
 192 the random number generator is seeded exactly once per process.
 193 .IP "\fBrrd_add_ptr(void ***dest, size_t *dest_size, void *src)\fR" 4
 194 .IX Item "rrd_add_ptr(void ***dest, size_t *dest_size, void *src)"
 195 Dynamically resize the array pointed to by \f(CW\*(C`dest\*(C'\fR.  \f(CW\*(C`dest_size\*(C'\fR is a
 196 pointer to the current size of \f(CW\*(C`dest\*(C'\fR.  Upon successful \fIrealloc()\fR, the
 197 \&\f(CW\*(C`dest_size\*(C'\fR is incremented by 1 and the \f(CW\*(C`src\*(C'\fR pointer is stored at the
 198 end of the new \f(CW\*(C`dest\*(C'\fR.  Returns 1 on success, 0 on failure.
 199 .Sp
 200 .Vb 5
 201 \&    type **arr = NULL;
 202 \&    type *elem = "whatever";
 203 \&    size_t arr_size = 0;
 204 \&    if (!rrd_add_ptr(&arr, &arr_size, elem))
 205 \&        handle_failure();
 206 .Ve
 207 .IP "\fBrrd_add_strdup(char ***dest, size_t *dest_size, char *src)\fR" 4
 208 .IX Item "rrd_add_strdup(char ***dest, size_t *dest_size, char *src)"
 209 Like \f(CW\*(C`rrd_add_ptr\*(C'\fR, except adds a \f(CW\*(C`strdup\*(C'\fR of the source string.
 210 .Sp
 211 .Vb 5
 212 \&    char **arr = NULL;
 213 \&    size_t arr_size = NULL;
 214 \&    char *str  = "example text";
 215 \&    if (!rrd_add_strdup(&arr, &arr_size, str))
 216 \&        handle_failure();
 217 .Ve
 218 .IP "\fBrrd_free_ptrs(void ***src, size_t *cnt)\fR" 4
 219 .IX Item "rrd_free_ptrs(void ***src, size_t *cnt)"
 220 Free an array of pointers allocated by \f(CW\*(C`rrd_add_ptr\*(C'\fR or
 221 \&\f(CW\*(C`rrd_add_strdup\*(C'\fR.  Also frees the array pointer itself.  On return, the
 222 source pointer will be \s-1NULL\s0 and the count will be zero.
 223 .Sp
 224 .Vb 3
 225 \&    /* created as above */
 226 \&    rrd_free_ptrs(&arr, &arr_size);
 227 \&    /* here, arr == NULL && arr_size == 0 */
 228 .Ve
 229 .IP "\fBrrd_mkdir_p(const char *pathname, mode_t mode)\fR" 4
 230 .IX Item "rrd_mkdir_p(const char *pathname, mode_t mode)"
 231 Create the directory named \f(CW\*(C`pathname\*(C'\fR including all of its parent
 232 directories (similar to \f(CW\*(C`mkdir \-p\*(C'\fR on the command line \- see \fImkdir\fR\|(1) for
 233 more information). The argument \f(CW\*(C`mode\*(C'\fR specifies the permissions to use. It
 234 is modified by the process's \f(CW\*(C`umask\*(C'\fR. See \fImkdir\fR\|(2) for more details.
 235 .Sp
 236 The function returns 0 on success, a negative value else. In case of an error,
 237 \&\f(CW\*(C`errno\*(C'\fR is set accordingly. Aside from the errors documented in \fImkdir\fR\|(2),
 238 the function may fail with the following errors:
 239 .RS 4
 240 .IP "\fB\s-1EINVAL\s0\fR" 4
 241 .IX Item "EINVAL"
 242 \&\f(CW\*(C`pathname\*(C'\fR is \f(CW\*(C`NULL\*(C'\fR or the empty string.
 243 .IP "\fB\s-1ENOMEM\s0\fR" 4
 244 .IX Item "ENOMEM"
 245 Insufficient memory was available.
 246 .IP "\fBany error returned by \f(BIstat\fB\|(2)\fR" 4
 247 .IX Item "any error returned by stat"
 248 .RE
 249 .RS 4
 250 .Sp
 251 In contrast to \fImkdir\fR\|(2), the function does \fBnot\fR fail if \f(CW\*(C`pathname\*(C'\fR
 252 already exists and is a directory.
 253 .RE
 254 .SH "AUTHOR"
 255 .IX Header "AUTHOR"
 256 \&\s-1RRD\s0 Contributors <rrd\-developers@lists.oetiker.ch>