home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _49def5ebffe92df3c76644d155cd38ad < prev    next >
Text File  |  2000-03-23  |  5KB  |  162 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::SNPP - Simple Network Pager Protocol Client</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::SNPP - Simple Network Pager Protocol Client</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="#note">NOTE</A></LI>
  25.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  26.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  27.     <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
  28.     <LI><A HREF="#methods">METHODS</A></LI>
  29.     <LI><A HREF="#exports">EXPORTS</A></LI>
  30.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  31.     <LI><A HREF="#author">AUTHOR</A></LI>
  32.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>Net::SNPP - Simple Network Pager Protocol Client</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  43. <UL>
  44. <LI>Linux</LI>
  45. <LI>Solaris</LI>
  46. <LI>Windows</LI>
  47. </UL>
  48. <HR>
  49. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  50. <PRE>
  51.     use Net::SNPP;
  52. </PRE>
  53. <PRE>
  54.  
  55.     # Constructors
  56.     $snpp = Net::SNPP->new('snpphost');
  57.     $snpp = Net::SNPP->new('snpphost', Timeout => 60);</PRE>
  58. <P>
  59. <HR>
  60. <H1><A NAME="note">NOTE</A></H1>
  61. <P>This module is not complete, yet !</P>
  62. <P>
  63. <HR>
  64. <H1><A NAME="description">DESCRIPTION</A></H1>
  65. <P>This module implements a client interface to the SNPP protocol, enabling
  66. a perl5 application to talk to SNPP servers. This documentation assumes
  67. that you are familiar with the SNPP protocol described in RFC1861.</P>
  68. <P>A new Net::SNPP object must be created with the <EM>new</EM> method. Once
  69. this has been done, all SNPP commands are accessed through this object.</P>
  70. <P>
  71. <HR>
  72. <H1><A NAME="examples">EXAMPLES</A></H1>
  73. <P>This example will send a pager message in one hour saying ``Your lunch is ready''</P>
  74. <PRE>
  75.     #!/usr/local/bin/perl -w
  76. </PRE>
  77. <PRE>
  78.  
  79.     use Net::SNPP;</PRE>
  80. <PRE>
  81.  
  82.     $snpp = Net::SNPP->new('snpphost');</PRE>
  83. <PRE>
  84.  
  85.     $snpp->send( Pager   => $some_pager_number,
  86.                  Message => "Your lunch is ready",
  87.                  Alert   => 1,
  88.                  Hold    => time + 3600, # lunch ready in 1 hour :-)
  89.                ) || die $snpp->message;</PRE>
  90. <PRE>
  91.  
  92.     $snpp->quit;</PRE>
  93. <P>
  94. <HR>
  95. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  96. <DL>
  97. <DT><STRONG><A NAME="item_new">new ( [ HOST, ] [ OPTIONS ] )</A></STRONG><BR>
  98. <DD>
  99. This is the constructor for a new Net::SNPP object. <CODE>HOST</CODE> is the
  100. name of the remote host to which a SNPP connection is required.
  101. <P>If <CODE>HOST</CODE> is not given, then the <CODE>SNPP_Host</CODE> specified in <CODE>Net::Config</CODE>
  102. will be used.</P>
  103. <P><CODE>OPTIONS</CODE> are passed in a hash like fashion, using key and value pairs.
  104. Possible options are:</P>
  105. <P><STRONG>Timeout</STRONG> - Maximum time, in seconds, to wait for a response from the
  106. SNPP server (default: 120)</P>
  107. <P><STRONG>Debug</STRONG> - Enable debugging information</P>
  108. <P>Example:</P>
  109. <PRE>
  110.     $snpp = Net::SNPP->new('snpphost',
  111.                            Debug => 1,
  112.                           );</PRE>
  113. <P></P></DL>
  114. <P>
  115. <HR>
  116. <H1><A NAME="methods">METHODS</A></H1>
  117. <P>Unless otherwise stated all methods return either a <EM>true</EM> or <EM>false</EM>
  118. value, with <EM>true</EM> meaning that the operation was a success. When a method
  119. states that it returns a value, failure will be returned as <EM>undef</EM> or an
  120. empty list.</P>
  121. <DL>
  122. <DT><STRONG><A NAME="item_reset">reset ()</A></STRONG><BR>
  123. <DD>
  124. <DT><STRONG><A NAME="item_help">help ()</A></STRONG><BR>
  125. <DD>
  126. Request help text from the server. Returns the text or undef upon failure
  127. <P></P>
  128. <DT><STRONG><A NAME="item_quit">quit ()</A></STRONG><BR>
  129. <DD>
  130. Send the QUIT command to the remote SNPP server and close the socket connection.
  131. <P></P></DL>
  132. <P>
  133. <HR>
  134. <H1><A NAME="exports">EXPORTS</A></H1>
  135. <P><CODE>Net::SNPP</CODE> exports all that <CODE>Net::CMD</CODE> exports, plus three more subroutines
  136. that can bu used to compare against the result of <CODE>status</CODE>. These are :-
  137. <CODE>CMD_2WAYERROR</CODE>, <CODE>CMD_2WAYOK</CODE>, and <CODE>CMD_2WAYQUEUED</CODE>.</P>
  138. <P>
  139. <HR>
  140. <H1><A NAME="see also">SEE ALSO</A></H1>
  141. <P><A HREF="../../../site/lib/Net/Cmd.html">the Net::Cmd manpage</A>
  142. RFC1861</P>
  143. <P>
  144. <HR>
  145. <H1><A NAME="author">AUTHOR</A></H1>
  146. <P>Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>></P>
  147. <P>
  148. <HR>
  149. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  150. <P>Copyright (c) 1995-1997 Graham Barr. All rights reserved.
  151. This program is free software; you can redistribute it and/or modify
  152. it under the same terms as Perl itself.</P>
  153. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  154. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  155. <STRONG><P CLASS=block> Net::SNPP - Simple Network Pager Protocol Client</P></STRONG>
  156. </TD></TR>
  157. </TABLE>
  158.  
  159. </BODY>
  160.  
  161. </HTML>
  162.