From: octo <octo>
Date: Mon, 1 May 2006 19:30:00 +0000 (+0000)
Subject: Added the ping_iterator_get_context(3) manpage.
X-Git-Tag: liboping-0.1.0~7
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=cca4bb71cb619b366108f570947d6831dd745e3e;p=collectd.git

Added the ping_iterator_get_context(3) manpage.
---

diff --git a/src/mans/Makefile.am b/src/mans/Makefile.am
index d683366b..5c4552a1 100644
--- a/src/mans/Makefile.am
+++ b/src/mans/Makefile.am
@@ -1,5 +1,6 @@
 man_MANS = liboping.3 ping_construct.3 ping_setopt.3 ping_host_add.3 \
-	   ping_send.3 ping_get_error.3 ping_iterator_get.3
+	   ping_send.3 ping_get_error.3 ping_iterator_get.3 \
+	   ping_iterator_get_info.3 ping_iterator_get_context.3
 
 liboping_3_SOURCES = liboping.pod
 ping_construct_3_SOURCES = ping_construct.pod
@@ -8,6 +9,8 @@ ping_host_add_3_SOURCES = ping_host_add.pod
 ping_send_3_SOURCES = ping_send.pod
 ping_get_error_3_SOURCES = ping_get_error.pod
 ping_iterator_get_3_SOURCES = ping_iterator_get.pod
+ping_iterator_get_info_3_SOURCES = ping_iterator_get_info.pod
+ping_iterator_get_context_3_SOURCES = ping_iterator_get_context.pod
 
 .pod.1:
 	pod2man --release=$(VERSION) --center=$(PACKAGE) $< >$@
diff --git a/src/mans/ping_construct.pod b/src/mans/ping_construct.pod
index 068bd262..20978916 100644
--- a/src/mans/ping_construct.pod
+++ b/src/mans/ping_construct.pod
@@ -26,8 +26,9 @@ The B<ping_construct> constructor returns a pointer to the allocated memory or N
 ping_setopt(3),
 ping_send(3),
 ping_host_add(3),
+ping_get_error(3),
 ping_iterator_get(3),
-ping_get_error(3)
+liboping(3)
 
 =head1 AUTHOR
 
diff --git a/src/mans/ping_iterator_get_context.pod b/src/mans/ping_iterator_get_context.pod
new file mode 100644
index 00000000..18ae4a0a
--- /dev/null
+++ b/src/mans/ping_iterator_get_context.pod
@@ -0,0 +1,45 @@
+=head1 NAME
+
+ping_iterator_get_context, ping_iterator_set_context - Store host-dependent data
+
+=head1 SYNOPSIS
+
+  #include <oping.h>
+
+  void *ping_iterator_get_context (pingobj_iter_t *iter);
+  void  ping_iterator_set_context (pingobj_iter_t *iter, void *context);
+
+=head1 DESCRIPTION
+
+B<ping_iterator_set_context> can be used to store host-specific data within the
+liboping structures. This data can be received again by calling
+B<ping_iterator_get_context>. The data itself is never touched by liboping. If
+you call ping_host_remove (see ping_host_add(3)) or ping_destroy (see
+ping_construct(3)) and the context is not NULL liboping will assume you know
+what you're doing and simply ignore the fact this might be a memory leak.
+
+The I<iter> argument is an iterator object as returned by ping_iterator_get(3)
+and ping_iterator_next.
+
+The I<context> argument of B<ping_iterator_set_context> is a pointer to
+anything and may be NULL.
+
+=head1 RETURN VALUE
+
+B<ping_iterator_get_context> returns the same pointer previously passed to
+B<ping_iterator_set_context> or NULL if B<ping_iterator_set_context> has never
+been called before.
+
+=head1 SEE ALSO
+
+ping_iterator_get(3),
+ping_construct(3),
+ping_host_add(3),
+liboping(3)
+
+=head1 AUTHOR
+
+liboping is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
+It's homepage can be found at L<http://verplant.org/liboping/>.
+
+(c) 2005, 2006 by Florian octo Forster.