lib: introduce bt_message_iterator_class

[babeltrace.git] / src / plugins / ctf / lttng-live / lttng-live.h

diff --git a/src/plugins/ctf/lttng-live/lttng-live.h b/src/plugins/ctf/lttng-live/lttng-live.h
index bb1c760ee6a6efe0aaf63bab26213c005711fcba..39bc5abc5a39b67dbcb8f3b5e869790725ec582f 100644 (file)
--- a/src/plugins/ctf/lttng-live/lttng-live.h
+++ b/src/plugins/ctf/lttng-live/lttng-live.h
@@ -110,7 +110,7 @@ struct lttng_live_stream_iterator {
         * The current message produced by this live stream iterator. Owned by
         * this.
         */
-       bt_message *current_msg;
+       const bt_message *current_msg;
 
        /* Timestamp in nanoseconds of the current message (current_msg). */
        int64_t current_msg_ts_ns;
@@ -129,14 +129,32 @@ struct lttng_live_metadata {
        bt_logging_level log_level;
        bt_self_component *self_comp;
 
-       /* Weak reference. */
-       struct lttng_live_trace *trace;
-
        uint64_t stream_id;
        /* Weak reference. */
        struct ctf_metadata_decoder *decoder;
 };
 
+enum lttng_live_metadata_stream_state {
+       /*
+        * The metadata needs to be updated. This is either because we just
+        * created the trace and haven't asked yet, or the relay specifically
+        * told us that new metadata is available.
+        */
+       LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
+       /*
+        * The metadata was updated and the relay has not told us we need to
+        * update it yet.
+        */
+       LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
+       /*
+        * The relay has closed this metadata stream. We set this in reaction
+        * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
+        * command to the relay. If this field is set, we have received all the
+        * metadata that we are ever going to get for that metadata stream.
+        */
+       LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
+};
+
 struct lttng_live_trace {
        bt_logging_level log_level;
        bt_self_component *self_comp;
@@ -161,7 +179,7 @@ struct lttng_live_trace {
        /* Owned by this. */
        GPtrArray *stream_iterators;
 
-       bool new_metadata_needed;
+       enum lttng_live_metadata_stream_state metadata_stream_state;
 };
 
 struct lttng_live_session {
@@ -238,6 +256,9 @@ struct lttng_live_msg_iter {
 
        /* Timestamp in nanosecond of the last message sent downstream. */
        int64_t last_msg_ts_ns;
+
+       /* True if the iterator was interrupted. */
+       bool was_interrupted;
 };
 
 enum lttng_live_iterator_status {
@@ -272,54 +293,38 @@ bt_component_class_query_method_status lttng_live_query(
 
 void lttng_live_component_finalize(bt_self_component_source *component);
 
-bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next(
+bt_message_iterator_class_next_method_status lttng_live_msg_iter_next(
                bt_self_message_iterator *iterator,
                bt_message_array_const msgs, uint64_t capacity,
                uint64_t *count);
 
-bt_component_class_message_iterator_initialize_method_status lttng_live_msg_iter_init(
+bt_message_iterator_class_initialize_method_status lttng_live_msg_iter_init(
                bt_self_message_iterator *self_msg_it,
                bt_self_message_iterator_configuration *config,
-               bt_self_component_source *self_comp,
+               bt_self_component *self_comp,
                bt_self_component_port_output *self_port);
 
 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
 
-int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
-
-enum lttng_live_attach_session_status {
-       LTTNG_LIVE_ATTACH_SESSION_STATUS_OK     = 0,
-       LTTNG_LIVE_ATTACH_SESSION_STATUS_ERROR  = -2,
-};
-
-enum lttng_live_attach_session_status lttng_live_attach_session(
+enum lttng_live_viewer_status lttng_live_session_attach(
                struct lttng_live_session *session,
                bt_self_message_iterator *self_msg_iter);
 
-int lttng_live_detach_session(struct lttng_live_session *session);
-enum lttng_live_iterator_status lttng_live_get_new_streams(
+enum lttng_live_viewer_status lttng_live_session_detach(
+               struct lttng_live_session *session);
+
+enum lttng_live_iterator_status lttng_live_session_get_new_streams(
                struct lttng_live_session *session,
                bt_self_message_iterator *self_msg_iter);
 
+struct lttng_live_trace *lttng_live_session_borrow_or_create_trace_by_id(
+               struct lttng_live_session *session, uint64_t trace_id);
+
 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
                uint64_t session_id,
                const char *hostname,
                const char *session_name);
 
-enum lttng_live_get_one_metadata_status {
-       /* The end of the metadata stream was reached. */
-       LTTNG_LIVE_GET_ONE_METADATA_STATUS_END      = 1,
-       /* One metadata packet was received and written to file. */
-       LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK       = 0,
-       /* The metadata stream was not found on the relay. */
-       LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED   = -1,
-       /*
-        * A critical error occurred when contacting the relay or while
-        * handling its response.
-        */
-       LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR    = -2,
-};
-
 /*
  * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata.
  * If new metadata is received, the function writes it to the provided file
@@ -339,14 +344,6 @@ enum ctf_msg_iter_medium_status lttng_live_get_stream_bytes(
                struct lttng_live_msg_iter *lttng_live_msg_iter,
                struct lttng_live_stream_iterator *stream, uint8_t *buf,
                uint64_t offset, uint64_t req_len, uint64_t *recv_len);
-void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
-               struct lttng_live_stream_iterator *stream_iter);
-void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
-               struct lttng_live_stream_iterator *stream_iter);
-
-struct lttng_live_trace *lttng_live_borrow_trace(
-               struct lttng_live_session *session, uint64_t trace_id);
-void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter);
 
 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);