From: octo Date: Mon, 1 May 2006 19:22:07 +0000 (+0000) Subject: Accidentally gave the wrong name to the right manpage.. X-Git-Tag: liboping-0.1.0~8 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=d38ec39d6f925de3aad746fc725b9d9c7df6a24a;p=collectd.git Accidentally gave the wrong name to the right manpage.. --- diff --git a/src/mans/ping_iterator_get_context.pod b/src/mans/ping_iterator_get_context.pod deleted file mode 100644 index 5833fc9a..00000000 --- a/src/mans/ping_iterator_get_context.pod +++ /dev/null @@ -1,96 +0,0 @@ -=head1 NAME - -ping_iterator_get_info - Constructor for the liboping class - -=head1 SYNOPSIS - - #include - - int ping_iterator_get_info (pingobj_iter_t *iter, - int info, - void *buffer, - size_t *buffer_len); - -=head1 DESCRIPTION - -The B method can be used on an host iterator to return -various information about the current host. - -The I argument is an iterator as returned by ping_iterator_get(3) or -ping_iterator_next(3). - -The I argument specifies the type of information returned. Use the -following defines: - -=over 4 - -=item B - -Return the hostname of the host the iterator points to. Since the name is -looked up using the socket address this may differ from the hostname passed to -ping_host_add(3). The hostname is actually looked up every time you call this -method, no cache is involved within liboping. - -It is recommended to include C and allocate B bytes of -buffer. - -=item B - -Return the address used in ASCII (i.e. human readable) format. The address is -looked up every time you call this method. 40 bytes should be sufficient for -the buffer (16 octets in hex format, seven colons and one null byte), but more -won't hurt. - -=item B - -Returns the address family of the host. The buffer should be ig enough to hold -an integer. The value is either B or B. - -=item B - -Return the last measured latency or less than zero if the timeout occured -before a echo response was received. The buffer should be big enough to hold a -double value. - -=item B - -Return the last sequence number sent. This number is increased regardless of -echo responses being received or not. The buffer should hold an integer. - -=item B - -Return the ident that is put into every ICMP packet sent to this host. Per -convention this usually is the PID of the sending process, but since liboping -can handle several hosts in parallel it uses a (pseudo-)random number here. The -buffer should be big enough to hold an integer value. - -=back - -The I argument is a pointer to an appropriately sized area of memory -where the result of the call will be stored. The I value is used as -input and output: When calling B it reports the size of -the memory region pointed to by I. The method will write the number of -bytes actually written to the memory into I before returning. - -=head1 RETURN VALUE - -B returns zero if it succeeds. - -B is returned if the value passed as I is unknown. Both, -I and I, will be left untouched in this case. - -If the requested information didn't fit into I then the size that would -have been needed is written into I; I itself is left -untouched. The return value is B in this case. - -=head1 SEE ALSO - -ping_iterator_get(3), -liboping(3) - -=head1 AUTHOR - -liboping is written by Florian octo Forster Eocto at verplant.orgE. -It's homepage can be found at L. - -(c) 2005, 2006 by Florian octo Forster. diff --git a/src/mans/ping_iterator_get_info.pod b/src/mans/ping_iterator_get_info.pod new file mode 100644 index 00000000..5833fc9a --- /dev/null +++ b/src/mans/ping_iterator_get_info.pod @@ -0,0 +1,96 @@ +=head1 NAME + +ping_iterator_get_info - Constructor for the liboping class + +=head1 SYNOPSIS + + #include + + int ping_iterator_get_info (pingobj_iter_t *iter, + int info, + void *buffer, + size_t *buffer_len); + +=head1 DESCRIPTION + +The B method can be used on an host iterator to return +various information about the current host. + +The I argument is an iterator as returned by ping_iterator_get(3) or +ping_iterator_next(3). + +The I argument specifies the type of information returned. Use the +following defines: + +=over 4 + +=item B + +Return the hostname of the host the iterator points to. Since the name is +looked up using the socket address this may differ from the hostname passed to +ping_host_add(3). The hostname is actually looked up every time you call this +method, no cache is involved within liboping. + +It is recommended to include C and allocate B bytes of +buffer. + +=item B + +Return the address used in ASCII (i.e. human readable) format. The address is +looked up every time you call this method. 40 bytes should be sufficient for +the buffer (16 octets in hex format, seven colons and one null byte), but more +won't hurt. + +=item B + +Returns the address family of the host. The buffer should be ig enough to hold +an integer. The value is either B or B. + +=item B + +Return the last measured latency or less than zero if the timeout occured +before a echo response was received. The buffer should be big enough to hold a +double value. + +=item B + +Return the last sequence number sent. This number is increased regardless of +echo responses being received or not. The buffer should hold an integer. + +=item B + +Return the ident that is put into every ICMP packet sent to this host. Per +convention this usually is the PID of the sending process, but since liboping +can handle several hosts in parallel it uses a (pseudo-)random number here. The +buffer should be big enough to hold an integer value. + +=back + +The I argument is a pointer to an appropriately sized area of memory +where the result of the call will be stored. The I value is used as +input and output: When calling B it reports the size of +the memory region pointed to by I. The method will write the number of +bytes actually written to the memory into I before returning. + +=head1 RETURN VALUE + +B returns zero if it succeeds. + +B is returned if the value passed as I is unknown. Both, +I and I, will be left untouched in this case. + +If the requested information didn't fit into I then the size that would +have been needed is written into I; I itself is left +untouched. The return value is B in this case. + +=head1 SEE ALSO + +ping_iterator_get(3), +liboping(3) + +=head1 AUTHOR + +liboping is written by Florian octo Forster Eocto at verplant.orgE. +It's homepage can be found at L. + +(c) 2005, 2006 by Florian octo Forster.