Changeset 15597 for lang/perl/Data-Valve

Show
Ignore:
Timestamp:
07/10/08 11:19:14 (5 years ago)
Author:
daisuke
Message:

doc related stuff

Location:
lang/perl/Data-Valve/trunk
Files:
2 added
4 modified

Legend:

Unmodified
Added
Removed

  • lang/perl/Data-Valve/trunk/lib/Data/Valve.pm

    r15595 r15597  
    6565 
    66661; 
     67 
     68__END__ 
     69 
     70=head1 NAME 
     71 
     72Data::Valve - Throttle Your Data 
     73 
     74=head1 SYNOPSIS 
     75 
     76  use Data::Valve; 
     77 
     78  my $valve = Data::Valve->new( 
     79    max_items => 10, 
     80    interval  => 30 
     81  ); 
     82 
     83  if ($valve->try_push()) { 
     84    print "ok\n"; 
     85  } else { 
     86    print "throttled\n"; 
     87  } 
     88 
     89  if ($valve->try_push(key => "foo")) { 
     90    print "ok\n"; 
     91  } else { 
     92    print "throttled\n"; 
     93  } 
     94 
     95=head1 DESCRIPTION 
     96 
     97Data::Valve is a throttler based on Data::Throttler. 
     98 
     99=head1 METHODS 
     100 
     101=head2 try_push([key => $key_name]) 
     102 
     103=cut 

  • lang/perl/Data-Valve/trunk/lib/Data/Valve/Bucket.pm

    r15595 r15597  
    1212 
    13131; 
     14 
     15__END__ 
     16 
     17=head1 NAME 
     18 
     19Data::Valve::Bucket - A Data Bucket 
     20 
     21=head1 METHODS 
     22 
     23=head2 new 
     24 
     25=head2 create 
     26 
     27=head2 try_push 
     28 
     29=head2 expire 
     30 
     31=head2 destroy 
     32 
     33=cut 

  • lang/perl/Data-Valve/trunk/lib/Data/Valve/BucketStore.pm

    r15595 r15597  
    2020 
    21211; 
     22 
     23__END__ 
     24 
     25=head1 NAME 
     26 
     27Data::Valve::BucketStore - Manage Buckets 
     28 
     29=head1 METHODS 
     30 
     31=head2 setup 
     32 
     33=cut 

  • lang/perl/Data-Valve/trunk/lib/Data/Valve/BucketStore/Memory.pm

    r15595 r15597  
    46461; 
    4747 
     48__END__ 
     49 
     50=head1 NAME 
     51 
     52Data::Valve::BucketStore::Memory - An In-Memory Bucket Store 
     53 
     54=head1 METHODS 
     55 
     56=head2 create_bucket 
     57 
     58=head2 try_push 
     59 
     60=cut