aboutsummaryrefslogtreecommitdiff
path: root/sensor/include
diff options
context:
space:
mode:
Diffstat (limited to 'sensor/include')
-rw-r--r--sensor/include/trygvis/sensor/io.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/sensor/include/trygvis/sensor/io.h b/sensor/include/trygvis/sensor/io.h
index dd1460b..71b0b84 100644
--- a/sensor/include/trygvis/sensor/io.h
+++ b/sensor/include/trygvis/sensor/io.h
@@ -208,6 +208,12 @@ class SampleStreamParser {
public:
virtual int process(mutable_buffers_1 &buffer) = 0;
+ /**
+ * Tells the parser that the data that has been written so far either "is it" (there is no more input) or that
+ * it should just process what it has so far. It is ok to call process() after again after this method.
+ *
+ * TODO: should probably be renamed to "process()", "flush()" or "done()".
+ */
virtual int finish() = 0;
virtual sample_format_type type() {