freeswan/doc/manpage.d/ipsec_anyaddr.3.html

   1 Content-type: text/html
   2
   3 <HTML><HEAD><TITLE>Manpage of IPSEC_ANYADDR</TITLE>
   4 </HEAD><BODY>
   5 <H1>IPSEC_ANYADDR</H1>
   6 Section: C Library Functions (3)<BR>Updated: 8 Sept 2000<BR><A HREF="#index">Index</A>
   7 <A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
   8
   9
  10 <A NAME="lbAB">&nbsp;</A>
  11 <H2>NAME</H2>
  12
  13 ipsec anyaddr - get &quot;any&quot; address
  14 <BR>
  15
  16 ipsec isanyaddr - test address for equality to &quot;any&quot; address
  17 <BR>
  18
  19 ipsec unspecaddr - get &quot;unspecified&quot; address
  20 <BR>
  21
  22 ipsec isunspecaddr - test address for equality to &quot;unspecified&quot; address
  23 <BR>
  24
  25 ipsec loopbackaddr - get loopback address
  26 <BR>
  27
  28 ipsec isloopbackaddr - test address for equality to loopback address
  29 <A NAME="lbAC">&nbsp;</A>
  30 <H2>SYNOPSIS</H2>
  31
  32 <B>#include &lt;<A HREF="file:/usr/include/freeswan.h">freeswan.h</A>&gt;</B>
  33
  34 <P>
  35 <B>const char *anyaddr(int af, ip_address *dst);</B>
  36
  37 <BR>
  38
  39 <B>int isanyaddr(const ip_address *src);</B>
  40
  41 <BR>
  42
  43 <B>const char *unspecaddr(int af, ip_address *dst);</B>
  44
  45 <BR>
  46
  47 <B>int isunspecaddr(const ip_address *src);</B>
  48
  49 <BR>
  50
  51 <B>const char *loopbackaddr(int af, ip_address *dst);</B>
  52
  53 <BR>
  54
  55 <B>int isloopbackaddr(const ip_address *src);</B>
  56
  57 <A NAME="lbAD">&nbsp;</A>
  58 <H2>DESCRIPTION</H2>
  59
  60 These functions fill in, and test for, special values of the
  61 <I>ip_address</I>
  62
  63 type.
  64 <P>
  65
  66 <I>Anyaddr</I>
  67
  68 fills in the destination
  69 <I>*dst</I>
  70
  71 with the ``any'' address of address family
  72 <I>af</I>
  73
  74 (normally
  75 <B>AF_INET</B>
  76
  77 or
  78 <B>AF_INET6</B>).
  79
  80 The IPv4 ``any'' address is the one embodied in the old
  81 <B>INADDR_ANY</B>
  82
  83 macro.
  84 <P>
  85
  86 <I>Isanyaddr</I>
  87
  88 returns
  89 <B>1</B>
  90
  91 if the
  92 <I>src</I>
  93
  94 address equals the ``any'' address,
  95 and
  96 <B>0</B>
  97
  98 otherwise.
  99 <P>
 100
 101 Similarly,
 102 <I>unspecaddr</I>
 103
 104 supplies, and
 105 <I>isunspecaddr</I>
 106
 107 tests for,
 108 the ``unspecified'' address,
 109 which may be the same as the ``any'' address.
 110 <P>
 111
 112 Similarly,
 113 <I>loopbackaddr</I>
 114
 115 supplies, and
 116 <I>islookbackaddr</I>
 117
 118 tests for,
 119 the loopback address.
 120 <P>
 121
 122 <I>Anyaddr</I>,
 123
 124 <I>unspecaddr</I>,
 125
 126 and
 127 <I>loopbackaddr</I>
 128
 129 return
 130 <B>NULL</B>
 131
 132 for success and
 133 a pointer to a string-literal error message for failure;
 134 see DIAGNOSTICS.
 135 <A NAME="lbAE">&nbsp;</A>
 136 <H2>SEE ALSO</H2>
 137
 138 <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)
 139 <A NAME="lbAF">&nbsp;</A>
 140 <H2>DIAGNOSTICS</H2>
 141
 142 Fatal errors in the address-supplying functions are:
 143 unknown address family.
 144 <A NAME="lbAG">&nbsp;</A>
 145 <H2>HISTORY</H2>
 146
 147 Written for the FreeS/WAN project by Henry Spencer.
 148 <P>
 149
 150 <HR>
 151 <A NAME="index">&nbsp;</A><H2>Index</H2>
 152 <DL>
 153 <DT><A HREF="#lbAB">NAME</A><DD>
 154 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
 155 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
 156 <DT><A HREF="#lbAE">SEE ALSO</A><DD>
 157 <DT><A HREF="#lbAF">DIAGNOSTICS</A><DD>
 158 <DT><A HREF="#lbAG">HISTORY</A><DD>
 159 </DL>
 160 <HR>
 161 This document was created by
 162 <A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
 163 using the manual pages.<BR>
 164 Time: 05:09:30 GMT, June 19, 2001
 165 </BODY>
 166 </HTML>