home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _3b7b70eb4bb120d38b7efbc4e64a64f9 < prev    next >
Text File  |  2000-03-23  |  8KB  |  197 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::Cmd - Network Command class</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> Net::Cmd - Network Command class</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="#user methods">USER METHODS</A></LI>
  26.     <LI><A HREF="#class methods">CLASS METHODS</A></LI>
  27.     <LI><A HREF="#exports">EXPORTS</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>Net::Cmd - Network Command class (as used by FTP, SMTP etc)</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 Net::Cmd;
  49. </PRE>
  50. <PRE>
  51.  
  52.     @ISA = qw(Net::Cmd);</PRE>
  53. <P>
  54. <HR>
  55. <H1><A NAME="description">DESCRIPTION</A></H1>
  56. <P><CODE>Net::Cmd</CODE> is a collection of methods that can be inherited by a sub class
  57. of <CODE>IO::Handle</CODE>. These methods implement the functionality required for a
  58. command based protocol, for example FTP and SMTP.</P>
  59. <P>
  60. <HR>
  61. <H1><A NAME="user methods">USER METHODS</A></H1>
  62. <P>These methods provide a user interface to the <CODE>Net::Cmd</CODE> object.</P>
  63. <DL>
  64. <DT><STRONG><A NAME="item_debug">debug ( VALUE )</A></STRONG><BR>
  65. <DD>
  66. Set the level of debug information for this object. If <CODE>VALUE</CODE> is not given
  67. then the current state is returned. Otherwise the state is changed to 
  68. <CODE>VALUE</CODE> and the previous state returned.
  69. <P>Set the level of debug information for this object. If no argument is
  70. given then the current state is returned. Otherwise the state is
  71. changed to <CODE>$value</CODE>and the previous state returned.  Different packages
  72. may implement different levels of debug but, a  non-zero value result in
  73. copies of all commands and responses also being sent to STDERR.</P>
  74. <P>If <CODE>VALUE</CODE> is <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> then the debug level will be set to the default
  75. debug level for the class.</P>
  76. <P>This method can also be called as a <EM>static</EM> method to set/get the default
  77. debug level for a given class.</P>
  78. <P></P>
  79. <DT><STRONG><A NAME="item_message">message ()</A></STRONG><BR>
  80. <DD>
  81. Returns the text message returned from the last command
  82. <P></P>
  83. <DT><STRONG><A NAME="item_code">code ()</A></STRONG><BR>
  84. <DD>
  85. Returns the 3-digit code from the last command. If a command is pending
  86. then the value 0 is returned
  87. <P></P>
  88. <DT><STRONG><A NAME="item_ok">ok ()</A></STRONG><BR>
  89. <DD>
  90. Returns non-zero if the last code value was greater than zero and
  91. less than 400. This holds true for most command servers. Servers
  92. where this does not hold may override this method.
  93. <P></P>
  94. <DT><STRONG><A NAME="item_status">status ()</A></STRONG><BR>
  95. <DD>
  96. Returns the most significant digit of the current status code. If a command
  97. is pending then <CODE>CMD_PENDING</CODE> is returned.
  98. <P></P>
  99. <DT><STRONG><A NAME="item_datasend">datasend ( DATA )</A></STRONG><BR>
  100. <DD>
  101. Send data to the remote server, converting LF to CRLF. Any line starting
  102. with a '.' will be prefixed with another '.'.
  103. <CODE>DATA</CODE> may be an array or a reference to an array.
  104. <P></P>
  105. <DT><STRONG><A NAME="item_dataend">dataend ()</A></STRONG><BR>
  106. <DD>
  107. End the sending of data to the remote server. This is done by ensuring that
  108. the data already sent ends with CRLF then sending '.CRLF' to end the
  109. transmission. Once this data has been sent <A HREF="#item_dataend"><CODE>dataend</CODE></A> calls <A HREF="#item_response"><CODE>response</CODE></A> and
  110. returns true if <A HREF="#item_response"><CODE>response</CODE></A> returns CMD_OK.
  111. <P></P></DL>
  112. <P>
  113. <HR>
  114. <H1><A NAME="class methods">CLASS METHODS</A></H1>
  115. <P>These methods are not intended to be called by the user, but used or 
  116. over-ridden by a sub-class of <CODE>Net::Cmd</CODE></P>
  117. <DL>
  118. <DT><STRONG><A NAME="item_debug_print">debug_print ( DIR, TEXT )</A></STRONG><BR>
  119. <DD>
  120. Print debugging information. <CODE>DIR</CODE> denotes the direction <EM>true</EM> being
  121. data being sent to the server. Calls <A HREF="#item_debug_text"><CODE>debug_text</CODE></A> before printing to
  122. STDERR.
  123. <P></P>
  124. <DT><STRONG><A NAME="item_debug_text">debug_text ( TEXT )</A></STRONG><BR>
  125. <DD>
  126. This method is called to print debugging information. TEXT is
  127. the text being sent. The method should return the text to be printed
  128. <P>This is primarily meant for the use of modules such as FTP where passwords
  129. are sent, but we do not want to display them in the debugging information.</P>
  130. <P></P>
  131. <DT><STRONG><A NAME="item_command">command ( CMD [, ARGS, ... ])</A></STRONG><BR>
  132. <DD>
  133. Send a command to the command server. All arguments a first joined with
  134. a space character and CRLF is appended, this string is then sent to the
  135. command server.
  136. <P>Returns undef upon failure</P>
  137. <P></P>
  138. <DT><STRONG><A NAME="item_unsupported">unsupported ()</A></STRONG><BR>
  139. <DD>
  140. Sets the status code to 580 and the response text to 'Unsupported command'.
  141. Returns zero.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_response">response ()</A></STRONG><BR>
  144. <DD>
  145. Obtain a response from the server. Upon success the most significant digit
  146. of the status code is returned. Upon failure, timeout etc., <EM>undef</EM> is
  147. returned.
  148. <P></P>
  149. <DT><STRONG><A NAME="item_parse_response">parse_response ( TEXT )</A></STRONG><BR>
  150. <DD>
  151. This method is called by <A HREF="#item_response"><CODE>response</CODE></A> as a method with one argument. It should
  152. return an array of 2 values, the 3-digit status code and a flag which is true
  153. when this is part of a multi-line response and this line is not the list.
  154. <P></P>
  155. <DT><STRONG><A NAME="item_getline">getline ()</A></STRONG><BR>
  156. <DD>
  157. Retrieve one line, delimited by CRLF, from the remote server. Returns <EM>undef</EM>
  158. upon failure.
  159. <P><STRONG>NOTE</STRONG>: If you do use this method for any reason, please remember to add
  160. some <A HREF="#item_debug_print"><CODE>debug_print</CODE></A> calls into your method.</P>
  161. <P></P>
  162. <DT><STRONG><A NAME="item_ungetline">ungetline ( TEXT )</A></STRONG><BR>
  163. <DD>
  164. Unget a line of text from the server.
  165. <P></P>
  166. <DT><STRONG><A NAME="item_read_until_dot">read_until_dot ()</A></STRONG><BR>
  167. <DD>
  168. Read data from the remote server until a line consisting of a single '.'.
  169. Any lines starting with '..' will have one of the '.'s removed.
  170. <P>Returns a reference to a list containing the lines, or <EM>undef</EM> upon failure.</P>
  171. <P></P></DL>
  172. <P>
  173. <HR>
  174. <H1><A NAME="exports">EXPORTS</A></H1>
  175. <P><CODE>Net::Cmd</CODE> exports six subroutines, five of these, <CODE>CMD_INFO</CODE>, <CODE>CMD_OK</CODE>,
  176. <CODE>CMD_MORE</CODE>, <CODE>CMD_REJECT</CODE> and <CODE>CMD_ERROR</CODE> ,correspond to possible results
  177. of <A HREF="#item_response"><CODE>response</CODE></A> and <A HREF="#item_status"><CODE>status</CODE></A>. The sixth is <CODE>CMD_PENDING</CODE>.</P>
  178. <P>
  179. <HR>
  180. <H1><A NAME="author">AUTHOR</A></H1>
  181. <P>Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>></P>
  182. <P>
  183. <HR>
  184. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  185. <P>Copyright (c) 1995-1997 Graham Barr. All rights reserved.
  186. This program is free software; you can redistribute it and/or modify
  187. it under the same terms as Perl itself.</P>
  188. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  189. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  190. <STRONG><P CLASS=block> Net::Cmd - Network Command class</P></STRONG>
  191. </TD></TR>
  192. </TABLE>
  193.  
  194. </BODY>
  195.  
  196. </HTML>
  197.