Changeset 4879 for trunk/Nebulous/lib

Timestamp:

Aug 25, 2005, 1:42:34 PM (21 years ago)

Author:

jhoblitt

Message:

document object methods

File:

• trunk/Nebulous/lib/Nebulous/Client.pod (modified) (2 diffs)

trunk/Nebulous/lib/Nebulous/Client.pod

@@ -37 +37 @@
 =head2 Import Parameters
 
-This module accepts a hash as argument to it's C<import> method and exports no
-I<symbols>.
+This module accepts an optional hash as argument to it's C<import> method and
+exports no I<symbols>.
 
     use Nebulous::Client trace => qw( debug );
@@ -84 +84 @@
 =over 4
 
-=item * create
-
-=item * replicate
-
-=item * cull
-
-=item * lock
-
-=item * unlock
-
-=item * find_instances
-
-=item * find
-
-=item * open
-
-=item * delete
-
-=item * copy
-
-=item * move
-
-=item * delete_instance
-
-=item * stat
+
+=item * create($key, $class, $volume, $comment).
+
+Creates and opens new storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * class 
+
+The storage class.
+
+This parameter is optional.
+
+=item * volume
+
+The preferred storage location of initial instance.
+
+This parameter is optional.
+
+=item * comment 
+
+The storage object comment.
+
+This parameter is optional.
+
+=back
+
+Returns a filehandle or C<undef> on failure.
+
+
+=item * replicate($key, $volume)
+
+Adds an instance to a storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * volume
+
+The preferred storage location of initial instance.
+
+This parameter is optional.
+
+=back
+
+Returns true on success.
+
+
+=item * cull($key)
+
+Removes an instance from a storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=back
+
+Returns true on success.
+
+
+=item * lock($key, $type, $timeout)
+
+Trys to acquire a lock on a storage object
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * type
+
+The type of lock to acquire.  Either C<read> or C<write>.
+
+=item * timeout
+
+The number of seconds to I<try> for a lock.
+
+This parameter is optional.
+
+=back
+
+Returns true on success.
+
+
+=item * unlock($key, $type)
+
+Trys to release a lock on a storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * type
+
+The type of lock to release.  Either C<read> or C<write>.
+
+=back
+
+Returns true on success.
+
+
+=item * find_instances($key, $volume)
+
+Lists all instances of a storage object
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * volume
+
+Restrict search to this storage location.
+
+This parameter is optional.
+
+=back
+
+Returns an arrayref of scalars.
+
+
+=item * find($key)
+
+Find any instance of a storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=back
+
+Returns the path to the instance.
+
+
+=item * open($key, $type)
+
+Open a storage object for read or write.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=item * type
+
+The type of lock to acquire.  Either C<read> or C<write>.
+
+=back
+
+Returns a filehandle or C<undef> on failure.
+
+
+=item * delete($key)
+
+Delete a storage object and all of it's instances.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=back
+
+Returns true on success.
+
+
+=item * copy($key, $new_key)
+
+Copy a storage object.
+
+=over 4
+
+=item * key
+
+The source object.
+
+=item * new_key
+
+The destination object.
+
+=back
+
+Returns true on success or C<undef> on failure.
+
+
+=item * move($key, $new_key)
+
+Rename a storage object.
+
+=over 4
+
+=item * key
+
+The source object.
+
+=item * new_key
+
+The destination object.
+
+=back
+
+Returns true on success or C<undef> on failure.
+
+
+=item * delete_instance($uri)
+
+Remove a storage object instance.
+
+=over 4
+
+=item * uri
+
+URI of the instance to remove.
+
+=back
+
+Returns true on success or C<undef> on failure.
+
+=item * stat($key)
+
+View the properties of a storage object.
+
+=over 4
+
+=item * key
+
+The storage object key (name).
+
+=back
+
+Returns an arrayref of scalars.
+
 
 =back