home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _78bb326efc3d3a3f36eb39d17dafa078 < prev    next >
Text File  |  2000-03-23  |  7KB  |  171 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>IO::Socket - Object interface to socket communications</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> IO::Socket - Object interface to socket communications</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.     <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
  26.     <LI><A HREF="#methods">METHODS</A></LI>
  27.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>IO::Socket - Object interface to socket communications</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.     use IO::Socket;</PRE>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P><CODE>IO::Socket</CODE> provides an object interface to creating and using sockets. It
  53. is built upon the <A HREF="../../lib/IO/Handle.html">the IO::Handle manpage</A> interface and inherits all the methods defined
  54. by <A HREF="../../lib/IO/Handle.html">the IO::Handle manpage</A>.</P>
  55. <P><CODE>IO::Socket</CODE> only defines methods for those operations which are common to all
  56. types of socket. Operations which are specified to a socket in a particular 
  57. domain have methods defined in sub classes of <CODE>IO::Socket</CODE></P>
  58. <P><CODE>IO::Socket</CODE> will export all functions (and constants) defined by <A HREF="../../lib/Socket.html">the Socket manpage</A>.</P>
  59. <P>
  60. <HR>
  61. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  62. <DL>
  63. <DT><STRONG><A NAME="item_new">new ( [ARGS] )</A></STRONG><BR>
  64. <DD>
  65. Creates an <CODE>IO::Socket</CODE>, which is a reference to a
  66. newly created symbol (see the <CODE>Symbol</CODE> package). <A HREF="#item_new"><CODE>new</CODE></A>
  67. optionally takes arguments, these arguments are in key-value pairs.
  68. <A HREF="#item_new"><CODE>new</CODE></A> only looks for one key <CODE>Domain</CODE> which tells new which domain
  69. the socket will be in. All other arguments will be passed to the
  70. configuration method of the package for that domain, See below.
  71. <PRE>
  72.  NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE</PRE>
  73. <P>As of VERSION 1.18 all IO::Socket objects have autoflush turned on
  74. by default. This was not the case with earlier releases.</P>
  75. <PRE>
  76.  NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE</PRE>
  77. <P></P></DL>
  78. <P>
  79. <HR>
  80. <H1><A NAME="methods">METHODS</A></H1>
  81. <P>See <A HREF="../../lib/Pod/perlfunc.html">the perlfunc manpage</A> for complete descriptions of each of the following
  82. supported <CODE>IO::Socket</CODE> methods, which are just front ends for the
  83. corresponding built-in functions:</P>
  84. <PRE>
  85.     socket
  86.     socketpair
  87.     bind
  88.     listen
  89.     accept
  90.     send
  91.     recv
  92.     peername (getpeername)
  93.     sockname (getsockname)
  94.     shutdown</PRE>
  95. <P>Some methods take slightly different arguments to those defined in <A HREF="../../lib/Pod/perlfunc.html">the perlfunc manpage</A>
  96. in attempt to make the interface more flexible. These are</P>
  97. <DL>
  98. <DT><STRONG><A NAME="item_accept"><CODE>accept([PKG])</CODE></A></STRONG><BR>
  99. <DD>
  100. perform the system call <A HREF="#item_accept"><CODE>accept</CODE></A> on the socket and return a new object. The
  101. new object will be created in the same class as the listen socket, unless
  102. <CODE>PKG</CODE> is specified. This object can be used to communicate with the client
  103. that was trying to connect. In a scalar context the new socket is returned,
  104. or undef upon failure. In an array context a two-element array is returned
  105. containing the new socket and the peer address; the list will
  106. be empty upon failure.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_socketpair">socketpair(DOMAIN, TYPE, PROTOCOL)</A></STRONG><BR>
  109. <DD>
  110. Call <A HREF="#item_socketpair"><CODE>socketpair</CODE></A> and return a list of two sockets created, or an
  111. empty list on failure.
  112. <P></P></DL>
  113. <P>Additional methods that are provided are:</P>
  114. <DL>
  115. <DT><STRONG><A NAME="item_timeout"><CODE>timeout([VAL])</CODE></A></STRONG><BR>
  116. <DD>
  117. Set or get the timeout value associated with this socket. If called without
  118. any arguments then the current setting is returned. If called with an argument
  119. the current setting is changed and the previous value returned.
  120. <P></P>
  121. <DT><STRONG><A NAME="item_sockopt">sockopt(OPT [, VAL])</A></STRONG><BR>
  122. <DD>
  123. Unified method to both set and get options in the SOL_SOCKET level. If called
  124. with one argument then getsockopt is called, otherwise setsockopt is called.
  125. <P></P>
  126. <DT><STRONG><A NAME="item_sockdomain">sockdomain</A></STRONG><BR>
  127. <DD>
  128. Returns the numerical number for the socket domain type. For example, for
  129. a AF_INET socket the value of &AF_INET will be returned.
  130. <P></P>
  131. <DT><STRONG><A NAME="item_socktype">socktype</A></STRONG><BR>
  132. <DD>
  133. Returns the numerical number for the socket type. For example, for
  134. a SOCK_STREAM socket the value of &SOCK_STREAM will be returned.
  135. <P></P>
  136. <DT><STRONG><A NAME="item_protocol">protocol</A></STRONG><BR>
  137. <DD>
  138. Returns the numerical number for the protocol being used on the socket, if
  139. known. If the protocol is unknown, as with an AF_UNIX socket, zero
  140. is returned.
  141. <P></P>
  142. <DT><STRONG><A NAME="item_connected">connected</A></STRONG><BR>
  143. <DD>
  144. If the socket is in a connected state the the peer address is returned.
  145. If the socket is not in a connected state then undef will be returned.
  146. <P></P></DL>
  147. <P>
  148. <HR>
  149. <H1><A NAME="see also">SEE ALSO</A></H1>
  150. <P><A HREF="../../lib/Socket.html">the Socket manpage</A>, <A HREF="../../lib/IO/Handle.html">the IO::Handle manpage</A>, <A HREF="../../lib/IO/Socket/INET.html">the IO::Socket::INET manpage</A>, <A HREF="../../lib/IO/Socket/UNIX.html">the IO::Socket::UNIX manpage</A></P>
  151. <P>
  152. <HR>
  153. <H1><A NAME="author">AUTHOR</A></H1>
  154. <P>Graham Barr. Currently maintained by the Perl Porters.  Please report all
  155. bugs to <<A HREF="mailto:perl5-porters@perl.org">perl5-porters@perl.org</A>>.</P>
  156. <P>
  157. <HR>
  158. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  159. <P>Copyright (c) 1997-8 Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>>. All rights reserved.
  160. This program is free software; you can redistribute it and/or
  161. modify it under the same terms as Perl itself.</P>
  162. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  163. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  164. <STRONG><P CLASS=block> IO::Socket - Object interface to socket communications</P></STRONG>
  165. </TD></TR>
  166. </TABLE>
  167.  
  168. </BODY>
  169.  
  170. </HTML>
  171.