Changeset 22433 for lang/perl/Method-Cached/trunk/lib/Method/Cached.pm

Timestamp:

10/31/08 16:16:22 (5 years ago)

Author:

bonnu

Message:

lang/perl/Method-Cached - POD was written only a little

Files:

• lang/perl/Method-Cached/trunk/lib/Method/Cached.pm (modified) (2 diffs)

lang/perl/Method-Cached/trunk/lib/Method/Cached.pm

@@ -136 +136 @@
   use Method::Cached;
    
-  sub message :Cached(5) {
-      join ':', @_, time, rand
-  }
+  sub message :Cached(5) { join ':', @_, time, rand }
   
   package main;
@@ -152 +150 @@
 
 Method::Cached offers the following mechanisms:
+
 The return value of the method is stored in storage, and
-the value stored when being execute it next time is returned. 
+the value stored when being execute it next time is returned.
+
+=head2 SETTING OF CACHED DOMAIN
+
+In beginning logic or the start-up script:
+
+  use Method::Cached;
+  
+  Method::Cached->default_domain({
+      storage_class => 'Cache::FastMmap',
+  });
+  
+  Method::Cached->set_domain(
+      'some-namespace' => {
+          storage_class => 'Cache::Memcached::Fast',
+          storage_args  => [
+              {
+                  # Parameter of constructor of class that uses it for cashe
+                  servers => [ '192.168.254.2:11211', '192.168.254.3:11211' ],
+                  ...
+              },
+          ],
+      },
+  );
+
+=head2 DEFINITION OF METHODS
+
+This function is mounting used as an attribute of the method. 
+
+=over 4
+
+=item B<:Cached ( DOMAIN_NAME, EXPIRES, [, KEY_RULE, ...] )>
+
+The cached rule is defined specifying the domain name.
+
+  sub message :Cached('some-namespace', 60 * 5, LIST) { ... }
+
+=item B<:Cached ( EXPIRES, [, KEY_RULE, ...] )>
+
+When the domain name is omitted, the domain of default is used.
+
+  sub message :Cached(60 * 30, LIST) { ... }
+
+=back
+
+=head2 RULE TO GENERATE KEY
+
+=over 4
+
+=item B<LIST>
+
+=item B<SERIALIZE>
+
+=item B<SELF_SHIFT>
+
+=item B<SELF_CODED>
+
+=item B<PER_OBJECT>
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item B<default_domain ($setting)>
+
+=item B<set_domain (%domain_settings)>
+
+=item B<get_domain ($domain_name)>
+
+=back
 
 =head1 AUTHOR