Changeset 876f5561 in mainline for uspace/lib/hound/include

Timestamp:

2013-04-10T23:06:52Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

f0a647c

Parents:

eb0ef51

Message:

libhound: doxygen

Location:

uspace/lib/hound/include/hound

Files:

• client.h (modified) (1 diff)
• protocol.h (modified) (4 diffs)

uspace/lib/hound/include/hound/client.h

@@ -54 +54 @@
 void hound_context_destroy(hound_context_t *hound);
 
-int hound_context_set_main_stream_format(hound_context_t *hound,
-    unsigned channels, unsigned rate, pcm_sample_format_t format);
+int hound_context_set_main_stream_params(hound_context_t *hound,
+    pcm_format_t format, size_t bsize);
 
 int hound_context_get_available_targets(hound_context_t *hound,

uspace/lib/hound/include/hound/protocol.h

@@ -41 +41 @@
 #include <pcm/format.h>
 
-const char *HOUND_SERVICE;
+extern const char *HOUND_SERVICE;
 
-enum {
+typedef enum {
         HOUND_SINK_APPS = 0x1,
         HOUND_SINK_DEVS = 0x2,
@@ -53 +53 @@
         HOUND_STREAM_IGNORE_UNDERFLOW = 0x2,
         HOUND_STREAM_IGNORE_OVERFLOW = 0x4,
-};
+} hound_flags_t;
 
 typedef async_sess_t hound_sess_t;
 typedef intptr_t hound_context_id_t;
 
+/**
+ * Check context id for errors.
+ * @param id Context id
+ * @return Error code.
+ */
 static inline int hound_context_id_err(hound_context_id_t id)
 {
@@ -72 +77 @@
 int hound_service_get_list(hound_sess_t *sess, const char ***ids, size_t *count,
     int flags, const char *connection);
+
+/**
+ * Wrapper for list queries with no connection parameter.
+ * @param[in] sess hound daemon session.
+ * @param[out] ids list of string identifiers
+ * @param[out] count Number of elements in @p ids
+ * @param[in] flags Flags limiting the query.
+ * @return Error code.
+ */
 static inline int hound_service_get_list_all(hound_sess_t *sess,
     const char ***ids, size_t *count, int flags)
@@ -92 +106 @@
 
 /* Server */
+
+/** Hound server interace structure */
 typedef struct hound_server_iface {
+        /** Create new context */
         int (*add_context)(void *, hound_context_id_t *, const char *, bool);
+        /** Destroy existing context */
         int (*rem_context)(void *, hound_context_id_t);
+        /** Query context direction */
         bool (*is_record_context)(void *, hound_context_id_t);
+        /** Get string identifiers of specified objects */
         int (*get_list)(void *, const char ***, size_t *, const char *, int);
+        /** Create connection between source and sink */
         int (*connect)(void *, const char *, const char *);
+        /** Destroy connection between source and sink */
         int (*disconnect)(void *, const char *, const char *);
+        /** Create new stream tied to the context */
         int (*add_stream)(void *, hound_context_id_t, int, pcm_format_t, size_t,
             void **);
+        /** Destroy existing stream */
         int (*rem_stream)(void *, void *);
+        /** Block until the stream buffer is empty */
         int (*drain_stream)(void *);
+        /** Write new data to the stream */
         int (*stream_data_write)(void *, const void *, size_t);
+        /** Read data from the stream */
         int (*stream_data_read)(void *, void *, size_t);
         void *server;