Changeset 17678

Timestamp:

May 14, 2008, 12:21:43 PM (18 years ago)

Author:

jhoblitt

Message:

document xattr methods

Location:

trunk/Nebulous-Server

Files:

• Changes (modified) (1 diff)
• lib/Nebulous/Server.pod (modified) (2 diffs)

trunk/Nebulous-Server/Changes

@@ -2 +2 @@
 
 0.10
+    - document xattr methods
     - change Nebulous::Server::stat() to not die when passed a non-existant key
     - change listxattr_object() to return an arrayref

trunk/Nebulous-Server/lib/Nebulous/Server.pod

@@ -22 +22 @@
     Nebulous::Server->getxattr_object( $key, $name );
     Nebulous::Server->listxattr_object( $key );
-    Nebulous::Server->removexattr_object( $key );
+    Nebulous::Server->removexattr_object( $key, $name );
     Nebulous::Server->find_objects( $pattern );
     Nebulous::Server->find_instances( $key, $volume );
@@ -75 +75 @@
 Accepts 2 parameters, all are mandatory.  Returns Boolean true.   Throws an
 exception on error.
+
+=item * setxattr_object( $key, $name, $value, $flags );
+
+Accepts 4 parameters, all are mandatory.  
+
+=over 4
+
+=item C<$key>
+
+Nebulous key to create the xattr on.
+
+=item C<$name>
+
+The xattr's name.
+
+=item C<$value>
+
+The xattr's value.
+
+=item C<$flags>
+
+The xattr key insertion mode flag.  Acceptable value are either C<"create"> or
+C<"replace">.  If the xattr already exists then trying to insert another xattr
+with the same name in C<"create"> mode will fail.
+
+=back
+
+Returns Boolean true on success.  Throws an exception on error.
+
+=item * getxattr_object( $key, $name );
+
+Accepts 2 parameters, all are mandatory.  
+
+=over 4
+
+=item C<$key>
+
+Nebulous key to fetch the xattr from.
+
+=item C<$name>
+
+The xattr's name.
+
+=back
+
+Returns the string value of C<$name> on success.  Throws an exception on error.
+
+=item * listxattr_object( $key );
+
+Accepts 1 mandatory parameter. 
+
+=over 4
+
+=item C<$key>
+
+List all xattrs on this Nebulous key.
+
+=back
+
+Returns an C<ARRAYREF> on success.  Throws an exception on error.
+
+=item * removexattr_object( $key, $name );
+
+Accepts 2 parameters, all are mandatory.  
+
+=over 4
+
+=item C<$key>
+
+Nebulous key to remove the xattr from.
+
+=item C<$name>
+
+The xattr's name.
+
+=back
+
+Returns Boolean true on success.  Throws an exception on error.
 
 =item * find_instance( $key, $volume );