summaryrefslogtreecommitdiffstats
path: root/src/kiro-sb.h
diff options
context:
space:
mode:
authorTimo Dritschler <timo.dritschler@kit.edu>2015-06-16 17:25:08 +0200
committerTimo Dritschler <timo.dritschler@kit.edu>2015-06-16 17:25:08 +0200
commitfa417b373e93903c8c41cdfd800a0311bc495e15 (patch)
treee262fea43ded5eaf69b2cf98e4ccee9c05173cd4 /src/kiro-sb.h
parent9ea244a2a7a52495bf033dd9f1cca7c865baf200 (diff)
downloadkiro-master.tar.gz
kiro-master.tar.bz2
kiro-master.tar.xz
kiro-master.zip
Pushed to version 1.3.0HEADmaster
Highlights: - KiroSb: Added kiro_sb_get_dma_pointer interface
Diffstat (limited to 'src/kiro-sb.h')
-rw-r--r--src/kiro-sb.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/kiro-sb.h b/src/kiro-sb.h
index a2b8604..32f1a48 100644
--- a/src/kiro-sb.h
+++ b/src/kiro-sb.h
@@ -340,6 +340,31 @@ gboolean kiro_sb_push (KiroSb *sb, void *data);
*/
void* kiro_sb_push_dma (KiroSb *sb);
+/**
+ * kiro_sb_get_dma_pointer:
+ * @sb: (transfer none) The #KiroSb to get the data from
+ *
+ * Returns a pointer where the next element will be stored.
+ * This operation is only valid for a 'serving' #KiroSb. Calling this
+ * function on a 'cloning' #KiroSb will allways return a %NULL pointer.
+ *
+ * Returns: (transfer none) (type gulong):
+ * A pointer to the memory where the next element will be stored
+ * Note:
+ * This function can be used to preemtively write data to the @sb without
+ * advancing the internal buffer (no remote sync will occur). It is the users
+ * responsibility to ensure no more data is written to the pointed memory then
+ * was specified with the initial call to kiro_sb_serve or returned by
+ * kiro_sb_get_size. Under no circumstances might the returned pointer be
+ * freed by the user. Once the element has been written, you can use
+ * kiro_sb_push_dma() to advance the buffer, making the remote side aware of
+ * the new element.
+ * See also:
+ * kiro_sb_get_size, kiro_sb_serve
+ *
+ * Since: 1.3
+ */
+void* kiro_sb_get_dma_pointer (KiroSb *sb);
G_END_DECLS