.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ping_iterator_get 3"
.TH ping_iterator_get 3 2024-03-07 1.10.0 liboping
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
ping_iterator_get, ping_iterator_next \- Iterate over all hosts of a liboping object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  #include <oping.h>
\&
\&  pingobj_iter_t *ping_iterator_get (pingobj_t *obj);
\&  pingobj_iter_t *ping_iterator_next (pingobj_iter_t *iter)
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These two functions can be used to iterate over all hosts associated with a
liboping object. You can use these methods as follows:
.PP
.Vb 1
\&  pingobj_iter_t *iter;
\&
\&  for (iter = ping_iterator_get (obj);
\&       iter != NULL;
\&       iter = ping_iterator_next (iter))
\&  {
\&    ...;
\&  }
.Ve
.PP
To get usable information from an iterator object (which is also an opaque data
type, just like the liboping object itself) use \fBping_iterator_get_info\fR\|(3) and
\&\fBping_iterator_get_context\fR\|(3).
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
The \fBping_iterator_get\fR returns an iterator for \fIobj\fR or NULL if no host is
associated with \fIobj\fR.
.PP
The \fBping_iterator_next\fR returns an iterator for the host following \fIiter\fR or
NULL if the last host has been reached.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBping_host_add\fR\|(3),
\&\fBping_iterator_get_info\fR\|(3),
\&\fBping_iterator_get_context\fR\|(3),
\&\fBliboping\fR\|(3)
.SH AUTHOR
.IX Header "AUTHOR"
liboping is written by Florian "octo" Forster <ff at octo.it>.
Its homepage can be found at <http://noping.cc/>.
.PP
Copyright (c) 2006\-2017 by Florian "octo" Forster.