summaryrefslogtreecommitdiff
path: root/doc/manpage.d/ipsec_isloopbackaddr.3.html
blob: 97423600541cc9a273914ea7f4ae90910c807d48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
Content-type: text/html

<HTML><HEAD><TITLE>Manpage of IPSEC_ANYADDR</TITLE>
</HEAD><BODY>
<H1>IPSEC_ANYADDR</H1>
Section: C Library Functions (3)<BR>Updated: 8 Sept 2000<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>


<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

ipsec anyaddr - get &quot;any&quot; address
<BR>

ipsec isanyaddr - test address for equality to &quot;any&quot; address
<BR>

ipsec unspecaddr - get &quot;unspecified&quot; address
<BR>

ipsec isunspecaddr - test address for equality to &quot;unspecified&quot; address
<BR>

ipsec loopbackaddr - get loopback address
<BR>

ipsec isloopbackaddr - test address for equality to loopback address
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>#include &lt;<A HREF="file:/usr/include/freeswan.h">freeswan.h</A>&gt;</B>

<P>
<B>const char *anyaddr(int af, ip_address *dst);</B>

<BR>

<B>int isanyaddr(const ip_address *src);</B>

<BR>

<B>const char *unspecaddr(int af, ip_address *dst);</B>

<BR>

<B>int isunspecaddr(const ip_address *src);</B>

<BR>

<B>const char *loopbackaddr(int af, ip_address *dst);</B>

<BR>

<B>int isloopbackaddr(const ip_address *src);</B>

<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

These functions fill in, and test for, special values of the
<I>ip_address</I>

type.
<P>

<I>Anyaddr</I>

fills in the destination
<I>*dst</I>

with the ``any'' address of address family
<I>af</I>

(normally
<B>AF_INET</B>

or
<B>AF_INET6</B>).

The IPv4 ``any'' address is the one embodied in the old
<B>INADDR_ANY</B>

macro.
<P>

<I>Isanyaddr</I>

returns
<B>1</B>

if the
<I>src</I>

address equals the ``any'' address,
and
<B>0</B>

otherwise.
<P>

Similarly,
<I>unspecaddr</I>

supplies, and
<I>isunspecaddr</I>

tests for,
the ``unspecified'' address,
which may be the same as the ``any'' address.
<P>

Similarly,
<I>loopbackaddr</I>

supplies, and
<I>islookbackaddr</I>

tests for,
the loopback address.
<P>

<I>Anyaddr</I>,

<I>unspecaddr</I>,

and
<I>loopbackaddr</I>

return
<B>NULL</B>

for success and
a pointer to a string-literal error message for failure;
see DIAGNOSTICS.
<A NAME="lbAE">&nbsp;</A>
<H2>SEE ALSO</H2>

<A HREF="inet.3.html">inet</A>(3), <A HREF="ipsec_addrtot.3.html">ipsec_addrtot</A>(3), <A HREF="ipsec_sameaddr.3.html">ipsec_sameaddr</A>(3)
<A NAME="lbAF">&nbsp;</A>
<H2>DIAGNOSTICS</H2>

Fatal errors in the address-supplying functions are:
unknown address family.
<A NAME="lbAG">&nbsp;</A>
<H2>HISTORY</H2>

Written for the FreeS/WAN project by Henry Spencer.
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">SEE ALSO</A><DD>
<DT><A HREF="#lbAF">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAG">HISTORY</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 21:40:17 GMT, November 11, 2003
</BODY>
</HTML>