Changeset 15790

Timestamp:

07/14/08 17:23:35 (5 years ago)

Author:

daisuke

Message:

docs

Location:

lang/perl/Data-Valve/trunk/lib/Data/Valve/BucketStore

Files:

• Object.pm (modified) (1 diff)
• WithKeyedMutex.pm (modified) (1 diff)

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

@@ -67 +67 @@
 Data::Valve::BucketStore::Object - Basic Object Storage
 
+=head1 SYNOPSIS
+
+  my $store = Data::Valve::BucketStore::Object->new(
+    store => $object,
+  );
+
 =head1 DESCRIPTION
 
 This storage type only needs an object which supports a get()/set() methods
 
+=head1 METHODS
+
+=head2 try_push
+
 =cut

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

@@ -56 +56 @@
 
 1;
+
+__END__
+
+=head1 NAME
+
+Data::Valve::BucketStore::WithKeyedMutex - Role To Add Locking Via KeyedMutex
+
+=head1 SYNOPSIS
+
+  package MyBucketStore;
+  use Moose;
+
+  with 'Data::Valve::BucketStore';
+  with 'Data::Valve::BucketStore::WithKeyedMutex';
+
+  no Moose;
+
+=head1 METHODS
+
+=head2 lock
+
+Attempts to acquire a lock. Returns KeyedMutex::Lock on success.
+
+If no KeyedMutex object is available (or KeyedMutex object errors out because 
+of, e.g., the server is unreacheable, etc.), returns 1. This basically means
+that your bucket store will run in degraded mode.
+
+On lock failures, returns whatever KeyedMutex->lock returns (false)
+
+=cut