Changeset 2528

Timestamp:

09/26/07 10:26:13 (1 year ago)

Author:

dgollub

Message:

Add some more API description for osync_objtype_sink_* "class".

Files:

• trunk/opensync/plugin/opensync_sink.c (modified) (4 diffs)
• trunk/opensync/plugin/opensync_sink_internals.h (modified) (1 diff)

trunk/opensync/plugin/opensync_sink.c

@@ -526 +526 @@
-}
-
+/*! @brief Checks if sink is able to write (commit)
+ *
+ * If the sink is not able to write, then no changes will be commited to
+ * the sink.
+ *
+ * @param sink Pointer to the sink
+ * @returns TRUE if the sink is able to write (commit), FALSE otherwise
+ */
-osync_bool osync_objtype_sink_get_write(OSyncObjTypeSink *sink)
-{
@@ -532 +540 @@
-}
-
+/*! @brief Sets the write status of the sink (commit)
+ *
+ * This function should only called 
+ * See osync_objtype_sink_get_write()
+ *
+ * @param sink Pointer to sink
+ * @param write TRUE if the sink is available, FALSE otherwise
+ *
+ */
-void osync_objtype_sink_set_write(OSyncObjTypeSink *sink, osync_bool write)
-{
@@ -538 +555 @@
-}
-
+/*! @brief Checks if sink is able to read single entries
+ *
+ * "Read" means to request a single entry and does not mean to get the
+ * latest changes since last sink. See osync_objtype_sink_get_getchanges().
+ * The read function explicitly means to read a single entry without triggering
+ * a full sync. This is used for example to check if a conflict between entries
+ * could be ignored. Ignoring conflicts is only possible if the sink is able to
+ * read this conflicting entries on the next sync without triggering a SlowSync.
+ *
+ * @param sink Pointer to the sink
+ * @returns TRUE if the sink is able to read single entries, FALSE otherwise
+ *
+ */
-osync_bool osync_objtype_sink_get_read(OSyncObjTypeSink *sink)
-{
@@ -544 +574 @@
-}
-
+/*! @brief Sets the (single) read status of a sink 
+ *
+ * See osync_objtype_sink_get_read()
+ *
+ * @param sink Pointer to the sink
+ * @param read TRUE if the sink is able to read (single entries), FALSE otherwise
+ *
+ */
-void osync_objtype_sink_set_read(OSyncObjTypeSink *sink, osync_bool read)
-{

trunk/opensync/plugin/opensync_sink_internals.h

@@ -29 +29 @@
-        void *userdata;
-        
+        /** The objtype type of this sink */
-        char *objtype;
+
+        /** The status if this sink is able to write (commit) */
-        osync_bool write;
+
+        /** The status if this sink is able to read (single entries) */
-        osync_bool read;
+
+        /** The status of this sink */
-        osync_bool enabled;
+
+        /** The request status of a slow-sync of this sink */
-        osync_bool slowsync;
+
-        int ref_count;
-        /** List to pile up changes for batch commit */