.\" -*- 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_send 3"
.TH ping_send 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_send \- Send ICMP echo requests to all associated hosts and wait for ICMP echo responses to arrive
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  #include <oping.h>
\&
\&  int ping_send (pingobj_t *obj);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBping_send\fR method is the actual workhorse of this library. It crafts ICMP
packets for the hosts associated with \fIobj\fR and sends them via the
corresponding sockets. It then waits for echo responses and receives them,
writing latency information for each host. The method returns after all echo
replies have been read or the timeout (set with \fBping_setopt\fR\|(3)) is reached.
.PP
After this function returns you will most likely iterate over all hosts using
\&\fBping_iterator_get\fR\|(3) and ping_iterator_next (described in the same manual
page) and call \fBping_iterator_get_info\fR\|(3) on each host.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\fBping_send\fR returns the number of echo replies received or a value less than
zero if an error occurred. Use \fBping_get_error\fR\|(3) to receive an error message.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBping_construct\fR\|(3),
\&\fBping_setopt\fR\|(3),
\&\fBping_iterator_get\fR\|(3),
\&\fBping_iterator_get_info\fR\|(3),
\&\fBping_get_error\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.