lib: make can_seek_beginning and can_seek_ns_from_origin methods return a status

[babeltrace.git] / include / babeltrace2 / graph / self-component-port-input-message-iterator.h

diff --git a/include/babeltrace2/graph/self-component-port-input-message-iterator.h b/include/babeltrace2/graph/self-component-port-input-message-iterator.h
index 814c197ff3d287a557dea337f08dc4363fd4c182..c83bd8db60cfd42d560f4649619486cc7b917ce9 100644 (file)
--- a/include/babeltrace2/graph/self-component-port-input-message-iterator.h
+++ b/include/babeltrace2/graph/self-component-port-input-message-iterator.h
@@ -1,8 +1,8 @@
-#ifndef BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
-#define BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
+#ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
+#define BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
 
 /*
- * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
+ * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -23,23 +23,31 @@
  * SOFTWARE.
  */
 
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
+
 #include <stdint.h>
 
-/* For bt_message_iterator_*_status */
 #include <babeltrace2/graph/message-iterator.h>
-
-/*
- * For bt_component, bt_message_iterator,
- * bt_self_component_port_input_message_iterator,
- * bt_self_component_port_input, bt_message_array_const, bt_bool,
- * __BT_UPCAST
- */
 #include <babeltrace2/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+typedef enum bt_self_component_port_input_message_iterator_create_from_message_iterator_status {
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK            = __BT_FUNC_STATUS_OK,
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR         = __BT_FUNC_STATUS_ERROR,
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_self_component_port_input_message_iterator_create_from_message_iterator_status;
+
+typedef enum bt_self_component_port_input_message_iterator_create_from_sink_component_status {
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK              = __BT_FUNC_STATUS_OK,
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR           = __BT_FUNC_STATUS_ERROR,
+       BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_self_component_port_input_message_iterator_create_from_sink_component_status;
+
 static inline
 bt_message_iterator *
 bt_self_component_port_input_message_iterator_as_message_iterator(
@@ -48,9 +56,17 @@ bt_self_component_port_input_message_iterator_as_message_iterator(
        return __BT_UPCAST(bt_message_iterator, iterator);
 }
 
-extern bt_self_component_port_input_message_iterator *
-bt_self_component_port_input_message_iterator_create(
-               bt_self_component_port_input *input_port);
+extern bt_self_component_port_input_message_iterator_create_from_message_iterator_status
+bt_self_component_port_input_message_iterator_create_from_message_iterator(
+               bt_self_message_iterator *self_msg_iter,
+               bt_self_component_port_input *input_port,
+               bt_self_component_port_input_message_iterator **message_iterator);
+
+extern bt_self_component_port_input_message_iterator_create_from_sink_component_status
+bt_self_component_port_input_message_iterator_create_from_sink_component(
+               bt_self_component_sink *self_comp,
+               bt_self_component_port_input *input_port,
+               bt_self_component_port_input_message_iterator **message_iterator);
 
 extern bt_component *
 bt_self_component_port_input_message_iterator_borrow_component(
@@ -61,13 +77,15 @@ bt_self_component_port_input_message_iterator_next(
                bt_self_component_port_input_message_iterator *iterator,
                bt_message_array_const *msgs, uint64_t *count);
 
-extern bt_bool
+extern bt_message_iterator_can_seek_ns_from_origin_status
 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
                bt_self_component_port_input_message_iterator *iterator,
-               int64_t ns_from_origin);
+               int64_t ns_from_origin, bt_bool *can_seek);
 
-extern bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
-               bt_self_component_port_input_message_iterator *iterator);
+extern bt_message_iterator_can_seek_beginning_status
+bt_self_component_port_input_message_iterator_can_seek_beginning(
+               bt_self_component_port_input_message_iterator *iterator,
+               bt_bool *can_seek);
 
 extern bt_message_iterator_seek_ns_from_origin_status
 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
@@ -101,4 +119,4 @@ extern void bt_self_component_port_input_message_iterator_put_ref(
 }
 #endif
 
-#endif /* BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */
+#endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */