home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _bd51c8789f7d18335dc203e5c8b717f4 < prev    next >
Text File  |  2000-03-23  |  4KB  |  108 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>File::CounterFile - Persistent counter 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> File::CounterFile - Persistent counter 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="#bugs">BUGS</A></LI>
  26.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  27.     <LI><A HREF="#author">AUTHOR</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>File::CounterFile - Persistent counter class</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.  use File::CounterFile;
  47.  $c = new File::CounterFile "COUNTER", "aa00";</PRE>
  48. <PRE>
  49.  $id = $c->inc;
  50.  open(F, ">F$id");</PRE>
  51. <P>
  52. <HR>
  53. <H1><A NAME="description">DESCRIPTION</A></H1>
  54. <P>This module implements a persistent counter class.  Each counter is
  55. represented by a separate file in the file system.  File locking is
  56. applied, so multiple processes might try to access the same counters
  57. at the same time without risk of counter destruction.</P>
  58. <P>You give the file name as the first parameter to the object
  59. constructor (<CODE>new</CODE>).  The file is created if it does not exist.</P>
  60. <P>If the file name does not start with ``/'' or ``.'', then it is
  61. interpreted as a file relative to <CODE>$File::CounterFile::DEFAULT_DIR</CODE>.
  62. The default value for this variable is initialized from the
  63. environment variable <CODE>TMPDIR</CODE>, or <EM>/usr/tmp</EM> is no environment
  64. variable is defined.  You may want to assign a different value to this
  65. variable before creating counters.</P>
  66. <P>If you pass a second parameter to the constructor, that sets the
  67. initial value for a new counter.  This parameter only takes effect
  68. when the file is created (i.e. it does not exist before the call).</P>
  69. <P>When you call the <CODE>inc()</CODE> method, you increment the counter value by
  70. one. When you call <CODE>dec()</CODE> the counter value is decrementd.  In both
  71. cases the new value is returned.  The <CODE>dec()</CODE> method only works for
  72. numerical counters (digits only).</P>
  73. <P>You can peek at the value of the counter (without incrementing it) by
  74. using the <CODE>value()</CODE> method.</P>
  75. <P>The counter can be locked and unlocked with the <A HREF="../../../lib/Pod/perlfunc.html#item_lock"><CODE>lock()</CODE></A> and
  76. <CODE>unlock()</CODE> methods.  Incrementing and value retrieval is faster when
  77. the counter is locked, because we do not have to update the counter
  78. file all the time.  You can query whether the counter is locked with
  79. the <CODE>locked()</CODE> method.</P>
  80. <P>There is also an operator overloading interface to the
  81. File::CounterFile object.  This means that you might use the <CODE>++</CODE>
  82. operator for incrementing the counter, <CODE>--</CODE> operator for decrementing
  83. and you can interpolate counters diretly into strings.</P>
  84. <P>
  85. <HR>
  86. <H1><A NAME="bugs">BUGS</A></H1>
  87. <P>It uses <A HREF="../../../lib/Pod/perlfunc.html#item_flock"><CODE>flock(2)</CODE></A> to lock the counter file.  This does not work on all
  88. systems.  Perhaps we should use the File::Lock module?</P>
  89. <P>
  90. <HR>
  91. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  92. <P>Copyright (c) 1995-1998 Gisle Aas. All rights reserved.</P>
  93. <P>This library is free software; you can redistribute it and/or
  94. modify it under the same terms as Perl itself.</P>
  95. <P>
  96. <HR>
  97. <H1><A NAME="author">AUTHOR</A></H1>
  98. <P>Gisle Aas <<A HREF="mailto:aas@sn.no">aas@sn.no</A>></P>
  99. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  100. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  101. <STRONG><P CLASS=block> File::CounterFile - Persistent counter class</P></STRONG>
  102. </TD></TR>
  103. </TABLE>
  104.  
  105. </BODY>
  106.  
  107. </HTML>
  108.