.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ping_setopt 3"
.TH ping_setopt 3 "2006-12-01" "0.3.3" "liboping"
.SH "NAME"
ping_setopt \- Set options for a liboping object
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  #include <oping.h>
.Ve
.PP
.Vb 1
\&  int ping_setopt (pingobj_t *obj, int opt, void *val);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBping_setopt\fR method sets options that effect all hosts associated with
the object \fIobj\fR and hosts that are yet to be added to the object.
.PP
The \fIobj\fR argument is a pointer to an liboping object, as returned by
\&\fIping_construct\fR\|(3).
.PP
The \fIopt\fR argument specifies the option to set. Use one of the following
constants:
.IP "\fB\s-1PING_OPT_TIMEOUT\s0\fR" 4
.IX Item "PING_OPT_TIMEOUT"
The time to wait for a \*(L"echo reply\*(R" to be received; in seconds. In this case
the memory pointed to by \fIval\fR is interpreted as a double value and must be
greater than zero. The default is \fB\s-1PING_DEF_TIMEOUT\s0\fR.
.IP "\fB\s-1PING_OPT_TTL\s0\fR" 4
.IX Item "PING_OPT_TTL"
The value written into the time-to-live (= \s-1TTL\s0) field of generated \s-1ICMP\s0
packets. The memory pointed to by \fIval\fR is interpreted as an integer. Valid
values are 1 through 255. Default is \fB\s-1PING_DEF_TTL\s0\fR.
.IP "\fB\s-1PING_OPT_AF\s0\fR" 4
.IX Item "PING_OPT_AF"
The address family to use. The memory pointed to by \fIval\fR is interpreted as an
integer and must be either \fB\s-1AF_UNSPEC\s0\fR, \fB\s-1AF_INET\s0\fR, or \fB\s-1AF_INET6\s0\fR. This
option only effects hosts that are being added \fBafter\fR this option has been
set. Default is \fB\s-1PING_DEF_AF\s0\fR. If you change this option, and a source address
is set (see \fB\s-1PING_OPT_SOURCE\s0\fR) that setting will be reset.
.IP "\fB\s-1PING_OPT_DATA\s0\fR" 4
.IX Item "PING_OPT_DATA"
Set the data to send. The value passed must be a char-pointer to a
null-terminated string. By default a 56 byte long string is used so that the
packet size of an ICMPv4 packet is exactly 64 bytes. That's the behavior of the
\&\fIping\fR\|(1) command.
.IP "\fB\s-1PING_OPT_SOURCE\s0\fR" 4
.IX Item "PING_OPT_SOURCE"
Set the source address to use. The value passed must be a char-pointer to a
null-terminated string. This option will ignore the address family setting (as
set with \fB\s-1PING_OPT_AF\s0\fR) and will set the object's address family according to
the source address assigned.
.PP
The \fIval\fR argument is a pointer to the new value. It must not be \s-1NULL\s0. It is
dereferences depending on the value of the \fIopt\fR argument, see above. The
memory pointed to by \fIval\fR is not changed.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\fBping_setopt\fR returns zero upon success or less than zero upon failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIping_construct\fR\|(3),
\&\fIliboping\fR\|(3)
.SH "AUTHOR"
.IX Header "AUTHOR"
liboping is written by Florian octo Forster <octo at verplant.org>.
It's homepage can be found at <http://verplant.org/liboping/>.
.PP
(c) 2005, 2006 by Florian octo Forster.