Typo: occured -> occurred

[babeltrace.git] / src / plugins / ctf / common / msg-iter / msg-iter.h

diff --git a/src/plugins/ctf/common/msg-iter/msg-iter.h b/src/plugins/ctf/common/msg-iter/msg-iter.h
index 5176a93b8910808c750ed4cb2a930f26d0285816..8774b36630f389c818b81c6a41418a7f929da1cd 100644 (file)
--- a/src/plugins/ctf/common/msg-iter/msg-iter.h
+++ b/src/plugins/ctf/common/msg-iter/msg-iter.h
@@ -45,7 +45,8 @@
  */
 
 /**
- * Medium operations status codes.
+ * Medium operations status codes.  These use the same values as
+ * libbabeltrace2.
  */
 enum ctf_msg_iter_medium_status {
        /**
@@ -64,6 +65,9 @@ enum ctf_msg_iter_medium_status {
        /** General error. */
        CTF_MSG_ITER_MEDIUM_STATUS_ERROR = -1,
 
+       /** Memory error. */
+       CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR = -12,
+
        /** Everything okay. */
        CTF_MSG_ITER_MEDIUM_STATUS_OK = 0,
 };
@@ -94,6 +98,9 @@ enum ctf_msg_iter_status {
        /** General error. */
        CTF_MSG_ITER_STATUS_ERROR = CTF_MSG_ITER_MEDIUM_STATUS_ERROR,
 
+       /** Memory error. */
+       CTF_MSG_ITER_STATUS_MEMORY_ERROR  = CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR,
+
        /** Everything okay. */
        CTF_MSG_ITER_STATUS_OK = CTF_MSG_ITER_MEDIUM_STATUS_OK,
 };
@@ -157,7 +164,7 @@ struct ctf_msg_iter_medium_ops {
         *     #CTF_MSG_ITER_MEDIUM_STATUS_EOF on the \em following
         *     call.
         *   - <b>#CTF_MSG_ITER_MEDIUM_STATUS_ERROR</b>: A fatal
-        *     error occured during this operation. In this case, the
+        *     error occurred during this operation. In this case, the
         *     message iterator function called by the user returns
         *     #CTF_MSG_ITER_STATUS_ERROR.
         *
@@ -186,6 +193,15 @@ struct ctf_msg_iter_medium_ops {
         */
        enum ctf_msg_iter_medium_status (* seek)(off_t offset, void *data);
 
+       /**
+        * Called when the message iterator wishes to inform the medium that it
+        * is about to start a new packet.
+        *
+        * After the iterator has called switch_packet, the following call to
+        * request_bytes must return the content at the start of the next
+        * packet.       */
+       enum ctf_msg_iter_medium_status (* switch_packet)(void *data);
+
        /**
         * Returns a stream instance (weak reference) for the given
         * stream class.
@@ -293,10 +309,6 @@ BT_HIDDEN
 enum ctf_msg_iter_status ctf_msg_iter_curr_packet_last_event_clock_snapshot(
                struct ctf_msg_iter *msg_it, uint64_t *last_event_cs);
 
-BT_HIDDEN
-void ctf_msg_iter_set_medops_data(struct ctf_msg_iter *msg_it,
-               void *medops_data);
-
 BT_HIDDEN
 enum ctf_msg_iter_status ctf_msg_iter_seek(
                struct ctf_msg_iter *msg_it, off_t offset);
@@ -317,14 +329,6 @@ void ctf_msg_iter_reset(struct ctf_msg_iter *msg_it);
 BT_HIDDEN
 void ctf_msg_iter_reset_for_next_stream_file(struct ctf_msg_iter *msg_it);
 
-BT_HIDDEN
-void ctf_msg_iter_set_emit_stream_beginning_message(struct ctf_msg_iter *msg_it,
-               bool val);
-
-BT_HIDDEN
-void ctf_msg_iter_set_emit_stream_end_message(struct ctf_msg_iter *msg_it,
-               bool val);
-
 BT_HIDDEN
 void ctf_msg_iter_set_dry_run(struct ctf_msg_iter *msg_it,
                bool val);