Changeset 5663

Timestamp:

Dec 2, 2005, 4:29:55 PM (21 years ago)

Author:

jhoblitt

Message:

add ->open_create()

File:

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

trunk/Nebulous/lib/Nebulous/Client.pod

@@ -13 +13 @@
     );
 
-    my $fh = $neb->create( "key", 0, "node01", "example" );
+    my $filename = $neb->create( "key", 0, "node01", "example" );
+    my $fh = $neb->open_create( "key", 0, "node01", "example" );
     $neb->replicate( "key", "node01" );
     $neb->cull( "key" );
@@ -87 +88 @@
 =item * create($key, $class, $volume, $comment).
 
+Creates a 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 local filename or C<undef> on failure.
+
+
+=item * open_create($key, $class, $volume, $comment).
+
 Creates and opens new storage object.