home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _22ffff0bea0b3ae24ab72e3b70270b24 < prev    next >
Text File  |  2000-03-23  |  9KB  |  243 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Win32::Pipe - Win32 Named Pipe</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> Win32::Pipe - Win32 Named Pipe</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.  
  27.         <LI><A HREF="#general use">General Use</A></LI>
  28.         <LI><A HREF="#benefits">Benefits</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
  32.     <LI><A HREF="#methods">METHODS</A></LI>
  33.     <LI><A HREF="#limitations">LIMITATIONS</A></LI>
  34.     <LI><A HREF="#installation notes">INSTALLATION NOTES</A></LI>
  35.     <LI><A HREF="#author">AUTHOR</A></LI>
  36.     <LI><A HREF="#disclaimer">DISCLAIMER</A></LI>
  37.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  38. </UL>
  39. <!-- INDEX END -->
  40.  
  41. <HR>
  42. <P>
  43. <H1><A NAME="name">NAME</A></H1>
  44. <P>Win32::Pipe - Win32 Named Pipe</P>
  45. <P>
  46. <HR>
  47. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  48. <UL>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <P>To use this extension, follow these basic steps. First, you need to
  54. 'use' the pipe extension:</P>
  55. <PRE>
  56.     use Win32::Pipe;</PRE>
  57. <P>Then you need to create a server side of a named pipe:</P>
  58. <PRE>
  59.     $Pipe = new Win32::Pipe("My Pipe Name");</PRE>
  60. <P>or if you are going to connect to pipe that has already been created:</P>
  61. <PRE>
  62.     $Pipe = new Win32::Pipe("\\\\server\\pipe\\My Pipe Name");</PRE>
  63. <PRE>
  64.     NOTE: The "\\\\server\\pipe\\" is necessary when connecting
  65.           to an existing pipe! If you are accessing the same
  66.           machine you could use "\\\\.\\pipe\\" but either way
  67.           works fine.</PRE>
  68. <P>You should check to see if <CODE>$Pipe</CODE> is indeed defined otherwise there
  69. has been an error.</P>
  70. <P>Whichever end is the server, it must now wait for a connection...</P>
  71. <PRE>
  72.     $Result = $Pipe->Connect();</PRE>
  73. <PRE>
  74.     NOTE: The client end does not do this! When the client creates
  75.           the pipe it has already connected!</PRE>
  76. <P>Now you can read and write data from either end of the pipe:</P>
  77. <PRE>
  78.     $Data = $Pipe->Read();</PRE>
  79. <PRE>
  80.     $Result = $Pipe->Write("Howdy! This is cool!");</PRE>
  81. <P>When the server is finished it must disconnect:</P>
  82. <PRE>
  83.     $Pipe->Disconnect();</PRE>
  84. <P>Now the server could <A HREF="#item_Connect"><CODE>Connect</CODE></A> again (and wait for another client) or
  85. it could destroy the named pipe...</P>
  86. <PRE>
  87.     $Data->Close();</PRE>
  88. <P>The client should <A HREF="#item_Close"><CODE>Close</CODE></A> in order to properly end the session.</P>
  89. <P>
  90. <HR>
  91. <H1><A NAME="description">DESCRIPTION</A></H1>
  92. <P>
  93. <H2><A NAME="general use">General Use</A></H2>
  94. <P>This extension gives Win32 Perl the ability to use Named Pipes. Why?
  95. Well considering that Win32 Perl does not (yet) have the ability to
  96. <A HREF="../../../lib/Pod/perlfunc.html#item_fork"><CODE>fork</CODE></A> I could not see what good the <A HREF="../../../lib/Pod/perlfunc.html#item_pipe"><CODE>pipe(X,Y)</CODE></A> was. Besides, where
  97. I am as an admin I must have several perl daemons running on several
  98. NT Servers. It dawned on me one day that if I could pipe all these
  99. daemons' output to my workstation (across the net) then it would be
  100. much easier to monitor. This was the impetus for an extension using
  101. Named Pipes. I think that it is kinda cool. :)</P>
  102. <P>
  103. <H2><A NAME="benefits">Benefits</A></H2>
  104. <P>And what are the benefits of this module?</P>
  105. <UL>
  106. <LI>
  107. You may create as many named pipes as you want (uh, well, as many as
  108. your resources will allow).
  109. <P></P>
  110. <LI>
  111. Currently there is a limit of 256 instances of a named pipe (once a
  112. pipe is created you can have 256 client/server connections to that
  113. name).
  114. <P></P>
  115. <LI>
  116. The default buffer size is 512 bytes; this can be altered by the
  117. <A HREF="#item_ResizeBuffer"><CODE>ResizeBuffer</CODE></A> method.
  118. <P></P>
  119. <LI>
  120. All named pipes are byte streams. There is currently no way to alter a
  121. pipe to be message based.
  122. <P></P>
  123. <LI>
  124. Other things that I cannot think of right now... :)
  125. <P></P></UL>
  126. <P>
  127. <HR>
  128. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  129. <DL>
  130. <DT><STRONG><A NAME="item_new">new ( NAME )</A></STRONG><BR>
  131. <DD>
  132. Creates a named pipe if used in server context or a connection to the
  133. specified named pipe if used in client context. Client context is
  134. determined by prepending $Name with ``\\\\''.
  135. <P>Returns <EM>true</EM> on success, <EM>false</EM> on failure.</P>
  136. <P></P></DL>
  137. <P>
  138. <HR>
  139. <H1><A NAME="methods">METHODS</A></H1>
  140. <DL>
  141. <DT><STRONG><A NAME="item_BufferSize">BufferSize ()</A></STRONG><BR>
  142. <DD>
  143. Returns the size of the instance of the buffer of the named pipe.
  144. <P></P>
  145. <DT><STRONG><A NAME="item_Connect">Connect ()</A></STRONG><BR>
  146. <DD>
  147. Tells the named pipe to create an instance of the named pipe and wait
  148. until a client connects. Returns <EM>true</EM> on success, <EM>false</EM> on
  149. failure.
  150. <P></P>
  151. <DT><STRONG><A NAME="item_Close">Close ()</A></STRONG><BR>
  152. <DD>
  153. Closes the named pipe.
  154. <P></P>
  155. <DT><STRONG><A NAME="item_Disconnect">Disconnect ()</A></STRONG><BR>
  156. <DD>
  157. Disconnects (and destroys) the instance of the named pipe from the
  158. client. Returns <EM>true</EM> on success, <EM>false</EM> on failure.
  159. <P></P>
  160. <DT><STRONG><A NAME="item_Error">Error ()</A></STRONG><BR>
  161. <DD>
  162. Returns the last error messages pertaining to the named pipe. If used
  163. in context to the package. Returns a list containing <CODE>ERROR_NUMBER</CODE>
  164. and <CODE>ERROR_TEXT</CODE>.
  165. <P></P>
  166. <DT><STRONG><A NAME="item_Read">Read ()</A></STRONG><BR>
  167. <DD>
  168. Reads from the named pipe. Returns data read from the pipe on success,
  169. undef on failure.
  170. <P></P>
  171. <DT><STRONG><A NAME="item_ResizeBuffer">ResizeBuffer ( SIZE )</A></STRONG><BR>
  172. <DD>
  173. Sets the size of the buffer of the instance of the named pipe to
  174. <CODE>SIZE</CODE>. Returns the size of the buffer on success, <EM>false</EM> on
  175. failure.
  176. <P></P>
  177. <DT><STRONG><A NAME="item_Write">Write ( DATA )</A></STRONG><BR>
  178. <DD>
  179. Writes <CODE>DATA</CODE> to the named pipe. Returns <EM>true</EM> on success, <EM>false</EM>
  180. on failure.
  181. <P></P></DL>
  182. <P>
  183. <HR>
  184. <H1><A NAME="limitations">LIMITATIONS</A></H1>
  185. <P>What known problems does this thing have?</P>
  186. <UL>
  187. <LI>
  188. If someone is waiting on a <A HREF="#item_Read"><CODE>Read</CODE></A> and the other end terminates then
  189. you will wait for one <STRONG>REALLY</STRONG> long time! (If anyone has an idea on
  190. how I can detect the termination of the other end let me know!)
  191. <P></P>
  192. <LI>
  193. All pipes are blocking. I am considering using threads and callbacks
  194. into Perl to perform async IO but this may be too much for my time
  195. stress. ;)
  196. <P></P>
  197. <LI>
  198. There is no security placed on these pipes.
  199. <P></P>
  200. <LI>
  201. This module has neither been optimized for speed nor optimized for
  202. memory consumption. This may run into memory bloat.
  203. <P></P></UL>
  204. <P>
  205. <HR>
  206. <H1><A NAME="installation notes">INSTALLATION NOTES</A></H1>
  207. <P>If you wish to use this module with a build of Perl other than
  208. ActivePerl, you may wish to fetch the source distribution for this
  209. module. The source is included as part of the <CODE>libwin32</CODE> bundle,
  210. which you can find in any CPAN mirror here:</P>
  211. <PRE>
  212.   modules/by-authors/Gurusamy_Sarathy/libwin32-0.151.tar.gz</PRE>
  213. <P>The source distribution also contains a pair of sample client/server
  214. test scripts. For the latest information on this module, consult the
  215. following web site:</P>
  216. <PRE>
  217.   <A HREF="http://www.roth.net/perl">http://www.roth.net/perl</A></PRE>
  218. <P>
  219. <HR>
  220. <H1><A NAME="author">AUTHOR</A></H1>
  221. <P>Dave Roth <<A HREF="mailto:rothd@roth.net">rothd@roth.net</A>></P>
  222. <P>
  223. <HR>
  224. <H1><A NAME="disclaimer">DISCLAIMER</A></H1>
  225. <P>I do not guarantee <STRONG>ANYTHING</STRONG> with this package. If you use it you
  226. are doing so <STRONG>AT YOUR OWN RISK</STRONG>! I may or may not support this
  227. depending on my time schedule.</P>
  228. <P>
  229. <HR>
  230. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  231. <P>Copyright (c) 1996 Dave Roth. All rights reserved.
  232. This program is free software; you can redistribute
  233. it and/or modify it under the same terms as Perl itself.</P>
  234. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  235. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  236. <STRONG><P CLASS=block> Win32::Pipe - Win32 Named Pipe</P></STRONG>
  237. </TD></TR>
  238. </TABLE>
  239.  
  240. </BODY>
  241.  
  242. </HTML>
  243.