home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _4ced288b129d6179a5f389f20700d71e < prev    next >
Text File  |  2000-03-23  |  8KB  |  190 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>inet_ntoa - load the C socket.h defines and structure manipulators</TITLE>
  5. <LINK REL="stylesheet" HREF="../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> inet_ntoa - load the C socket.h defines and structure manipulators</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25. </UL>
  26. <!-- INDEX END -->
  27.  
  28. <HR>
  29. <P>
  30. <H1><A NAME="name">NAME</A></H1>
  31. <P>Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators</P>
  32. <P>
  33. <HR>
  34. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  35. <UL>
  36. <LI>Linux</LI>
  37. <LI>Solaris</LI>
  38. <LI>Windows</LI>
  39. </UL>
  40. <HR>
  41. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  42. <PRE>
  43.     use Socket;</PRE>
  44. <PRE>
  45.     $proto = getprotobyname('udp');
  46.     socket(Socket_Handle, PF_INET, SOCK_DGRAM, $proto);
  47.     $iaddr = gethostbyname('hishost.com');
  48.     $port = getservbyname('time', 'udp');
  49.     $sin = sockaddr_in($port, $iaddr);
  50.     send(Socket_Handle, 0, 0, $sin);</PRE>
  51. <PRE>
  52.     $proto = getprotobyname('tcp');
  53.     socket(Socket_Handle, PF_INET, SOCK_STREAM, $proto);
  54.     $port = getservbyname('smtp', 'tcp');
  55.     $sin = sockaddr_in($port,inet_aton("127.1"));
  56.     $sin = sockaddr_in(7,inet_aton("localhost"));
  57.     $sin = sockaddr_in(7,INADDR_LOOPBACK);
  58.     connect(Socket_Handle,$sin);</PRE>
  59. <PRE>
  60.     ($port, $iaddr) = sockaddr_in(getpeername(Socket_Handle));
  61.     $peer_host = gethostbyaddr($iaddr, AF_INET);
  62.     $peer_addr = inet_ntoa($iaddr);</PRE>
  63. <PRE>
  64.     $proto = getprotobyname('tcp');
  65.     socket(Socket_Handle, PF_UNIX, SOCK_STREAM, $proto);
  66.     unlink('/tmp/usock');
  67.     $sun = sockaddr_un('/tmp/usock');
  68.     connect(Socket_Handle,$sun);</PRE>
  69. <P>
  70. <HR>
  71. <H1><A NAME="description">DESCRIPTION</A></H1>
  72. <P>This module is just a translation of the C <EM>socket.h</EM> file.
  73. Unlike the old mechanism of requiring a translated <EM>socket.ph</EM>
  74. file, this uses the <STRONG>h2xs</STRONG> program (see the Perl source distribution)
  75. and your native C compiler.  This means that it has a 
  76. far more likely chance of getting the numbers right.  This includes
  77. all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.</P>
  78. <P>Also, some common socket ``newline'' constants are provided: the
  79. constants <CODE>CR</CODE>, <CODE>LF</CODE>, and <CODE>CRLF</CODE>, as well as <CODE>$CR</CODE>, <CODE>$LF</CODE>, and
  80. <CODE>$CRLF</CODE>, which map to <CODE>\015</CODE>, <CODE>\012</CODE>, and <CODE>\015\012</CODE>.  If you do
  81. not want to use the literal characters in your programs, then use
  82. the constants provided here.  They are not exported by default, but can
  83. be imported individually, and with the <CODE>:crlf</CODE> export tag:</P>
  84. <PRE>
  85.     use Socket qw(:DEFAULT :crlf);</PRE>
  86. <P>In addition, some structure manipulation functions are available:</P>
  87. <DL>
  88. <DT><STRONG><A NAME="item_inet_aton_HOSTNAME">inet_aton HOSTNAME</A></STRONG><BR>
  89. <DD>
  90. Takes a string giving the name of a host, and translates that
  91. to the 4-byte string (structure). Takes arguments of both
  92. the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
  93. cannot be resolved, returns undef. For multi-homed hosts (hosts
  94. with more than one address), the first address found is returned.
  95. <P></P>
  96. <DT><STRONG><A NAME="item_inet_ntoa_IP_ADDRESS">inet_ntoa IP_ADDRESS</A></STRONG><BR>
  97. <DD>
  98. Takes a four byte ip address (as returned by <CODE>inet_aton())</CODE>
  99. and translates it into a string of the form 'd.d.d.d'
  100. where the 'd's are numbers less than 256 (the normal
  101. readable four dotted number notation for internet addresses).
  102. <P></P>
  103. <DT><STRONG><A NAME="item_INADDR_ANY">INADDR_ANY</A></STRONG><BR>
  104. <DD>
  105. Note: does not return a number, but a packed string.
  106. <P>Returns the 4-byte wildcard ip address which specifies any
  107. of the hosts ip addresses. (A particular machine can have
  108. more than one ip address, each address corresponding to
  109. a particular network interface. This wildcard address
  110. allows you to bind to all of them simultaneously.)
  111. Normally equivalent to inet_aton('0.0.0.0').</P>
  112. <P></P>
  113. <DT><STRONG><A NAME="item_INADDR_BROADCAST">INADDR_BROADCAST</A></STRONG><BR>
  114. <DD>
  115. Note: does not return a number, but a packed string.
  116. <P>Returns the 4-byte 'this-lan' ip broadcast address.
  117. This can be useful for some protocols to solicit information
  118. from all servers on the same LAN cable.
  119. Normally equivalent to inet_aton('255.255.255.255').</P>
  120. <P></P>
  121. <DT><STRONG><A NAME="item_INADDR_LOOPBACK">INADDR_LOOPBACK</A></STRONG><BR>
  122. <DD>
  123. Note - does not return a number.
  124. <P>Returns the 4-byte loopback address. Normally equivalent
  125. to inet_aton('localhost').</P>
  126. <P></P>
  127. <DT><STRONG><A NAME="item_INADDR_NONE">INADDR_NONE</A></STRONG><BR>
  128. <DD>
  129. Note - does not return a number.
  130. <P>Returns the 4-byte 'invalid' ip address. Normally equivalent
  131. to inet_aton('255.255.255.255').</P>
  132. <P></P>
  133. <DT><STRONG><A NAME="item_sockaddr_in_PORT%2C_ADDRESS">sockaddr_in PORT, ADDRESS</A></STRONG><BR>
  134. <DD>
  135. <DT><STRONG><A NAME="item_sockaddr_in_SOCKADDR_IN">sockaddr_in SOCKADDR_IN</A></STRONG><BR>
  136. <DD>
  137. In an array context, unpacks its SOCKADDR_IN argument and returns an array
  138. consisting of (PORT, ADDRESS).  In a scalar context, packs its (PORT,
  139. ADDRESS) arguments as a SOCKADDR_IN and returns it.  If this is confusing,
  140. use <CODE>pack_sockaddr_in()</CODE> and <CODE>unpack_sockaddr_in()</CODE> explicitly.
  141. <P></P>
  142. <DT><STRONG><A NAME="item_pack_sockaddr_in_PORT%2C_IP_ADDRESS">pack_sockaddr_in PORT, IP_ADDRESS</A></STRONG><BR>
  143. <DD>
  144. Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
  145. inet_aton()). Returns the sockaddr_in structure with those arguments
  146. packed in with AF_INET filled in.  For internet domain sockets, this
  147. structure is normally what you need for the arguments in bind(),
  148. connect(), and send(), and is also returned by getpeername(),
  149. <A HREF="../lib/Pod/perlfunc.html#item_getsockname"><CODE>getsockname()</CODE></A> and recv().
  150. <P></P>
  151. <DT><STRONG><A NAME="item_unpack_sockaddr_in_SOCKADDR_IN">unpack_sockaddr_in SOCKADDR_IN</A></STRONG><BR>
  152. <DD>
  153. Takes a sockaddr_in structure (as returned by <CODE>pack_sockaddr_in())</CODE> and
  154. returns an array of two elements: the port and the 4-byte ip-address.
  155. Will croak if the structure does not have AF_INET in the right place.
  156. <P></P>
  157. <DT><STRONG><A NAME="item_sockaddr_un_PATHNAME">sockaddr_un PATHNAME</A></STRONG><BR>
  158. <DD>
  159. <DT><STRONG><A NAME="item_sockaddr_un_SOCKADDR_UN">sockaddr_un SOCKADDR_UN</A></STRONG><BR>
  160. <DD>
  161. In an array context, unpacks its SOCKADDR_UN argument and returns an array
  162. consisting of (PATHNAME).  In a scalar context, packs its PATHNAME
  163. arguments as a SOCKADDR_UN and returns it.  If this is confusing, use
  164. <CODE>pack_sockaddr_un()</CODE> and <CODE>unpack_sockaddr_un()</CODE> explicitly.
  165. These are only supported if your system has <<EM>sys/un.h</EM>>.
  166. <P></P>
  167. <DT><STRONG><A NAME="item_pack_sockaddr_un_PATH">pack_sockaddr_un PATH</A></STRONG><BR>
  168. <DD>
  169. Takes one argument, a pathname. Returns the sockaddr_un structure with
  170. that path packed in with AF_UNIX filled in. For unix domain sockets, this
  171. structure is normally what you need for the arguments in bind(),
  172. connect(), and send(), and is also returned by getpeername(),
  173. <A HREF="../lib/Pod/perlfunc.html#item_getsockname"><CODE>getsockname()</CODE></A> and recv().
  174. <P></P>
  175. <DT><STRONG><A NAME="item_unpack_sockaddr_un_SOCKADDR_UN">unpack_sockaddr_un SOCKADDR_UN</A></STRONG><BR>
  176. <DD>
  177. Takes a sockaddr_un structure (as returned by <CODE>pack_sockaddr_un())</CODE>
  178. and returns the pathname.  Will croak if the structure does not
  179. have AF_UNIX in the right place.
  180. <P></P></DL>
  181. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  182. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  183. <STRONG><P CLASS=block> inet_ntoa - load the C socket.h defines and structure manipulators</P></STRONG>
  184. </TD></TR>
  185. </TABLE>
  186.  
  187. </BODY>
  188.  
  189. </HTML>
  190.