Changeset 743ce51 in mainline for uspace/app/bithenge/blob.h

Timestamp:

2012-05-25T03:49:21Z (12 years ago)

Author:

Sean Bartell <wingedtachikoma@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

1923501

Parents:

a54bd98

Message:

Bithenge: various fixes and style.

File:

• uspace/app/bithenge/blob.h (modified) (4 diffs)

uspace/app/bithenge/blob.h

@@ -78 +78 @@
  * @memberof bithenge_sequential_blob_t */
 typedef struct bithenge_sequential_blob_ops_t {
+
+        /** Get the total size of the blob. If the total size cannot be
+         * determined easily, this field may be null or return an error,
+         * forcing the entire blob to be read to determine its size.
+         *
+         * @memberof bithenge_blob_t
+         * @param blob The blob.
+         * @param[out] size Total size of the blob.
+         * @return EOK on success or an error code from errno.h.
+         */
         int (*size)(bithenge_sequential_blob_t *blob, aoff64_t *size);
+
+        /** Read the next part of the blob. If the requested data extends
+         * beyond the end of the blob, the data up until the end of the blob
+         * will be read.
+         *
+         * @param blob The blob.
+         * @param[out] buffer Buffer to read into. If an error occurs, the contents are
+         * undefined.
+         * @param[in,out] size Number of bytes to read; may be 0. If not enough
+         * data is left in the blob, the actual number of bytes read should be
+         * stored here. If an error occurs, the contents are undefined.
+         * @return EOK on success or an error code from errno.h.
+         */
         int (*read)(bithenge_sequential_blob_t *blob, char *buffer,
             aoff64_t *size);
+
+        /** Destroy the blob.
+         * @param blob The blob.
+         * @return EOK on success or an error code from errno.h. */
         int (*destroy)(bithenge_sequential_blob_t *blob);
 } bithenge_sequential_blob_ops_t;
@@ -91 +118 @@
  * @return EOK on success or an error code from errno.h.
  */
-static inline int bithenge_blob_size(bithenge_blob_t *blob, aoff64_t *size) {
+static inline int bithenge_blob_size(bithenge_blob_t *blob, aoff64_t *size)
+{
+        assert(blob);
+        assert(blob->ops);
         return blob->ops->size(blob, size);
 }
@@ -110 +140 @@
  * @return EOK on success or an error code from errno.h.
  */
-static inline int bithenge_blob_read(bithenge_blob_t *blob, aoff64_t offset, char *buffer, aoff64_t *size) {
+static inline int bithenge_blob_read(bithenge_blob_t *blob, aoff64_t offset,
+    char *buffer, aoff64_t *size)
+{
+        assert(blob);
+        assert(blob->ops);
         return blob->ops->read(blob, offset, buffer, size);
 }
@@ -119 +153 @@
  * @return EOK on success or an error code from errno.h.
  */
-static inline int bithenge_blob_destroy(bithenge_blob_t *blob) {
+static inline int bithenge_blob_destroy(bithenge_blob_t *blob)
+{
+        assert(blob);
+        assert(blob->ops);
         return blob->ops->destroy(blob);
 }