include/babeltrace2/graph/self-component-port-input-message-iterator.h

   1 #ifndef BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
   2 #define BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <stdint.h>
  27
  28 /* For bt_message_iterator_*_status */
  29 #include <babeltrace2/graph/message-iterator.h>
  30
  31 /*
  32  * For bt_component, bt_message_iterator,
  33  * bt_self_component_port_input_message_iterator,
  34  * bt_self_component_port_input, bt_message_array_const, bt_bool,
  35  * __BT_UPCAST
  36  */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 static inline
  44 bt_message_iterator *
  45 bt_self_component_port_input_message_iterator_as_message_iterator(
  46                 bt_self_component_port_input_message_iterator *iterator)
  47 {
  48         return __BT_UPCAST(bt_message_iterator, iterator);
  49 }
  50
  51 extern bt_self_component_port_input_message_iterator *
  52 bt_self_component_port_input_message_iterator_create(
  53                 bt_self_component_port_input *input_port);
  54
  55 extern bt_component *
  56 bt_self_component_port_input_message_iterator_borrow_component(
  57                 bt_self_component_port_input_message_iterator *iterator);
  58
  59 extern bt_message_iterator_next_status
  60 bt_self_component_port_input_message_iterator_next(
  61                 bt_self_component_port_input_message_iterator *iterator,
  62                 bt_message_array_const *msgs, uint64_t *count);
  63
  64 extern bt_bool
  65 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
  66                 bt_self_component_port_input_message_iterator *iterator,
  67                 int64_t ns_from_origin);
  68
  69 extern bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
  70                 bt_self_component_port_input_message_iterator *iterator);
  71
  72 extern bt_message_iterator_seek_ns_from_origin_status
  73 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
  74                 bt_self_component_port_input_message_iterator *iterator,
  75                 int64_t ns_from_origin);
  76
  77 extern bt_message_iterator_seek_beginning_status
  78 bt_self_component_port_input_message_iterator_seek_beginning(
  79                 bt_self_component_port_input_message_iterator *iterator);
  80
  81 extern void bt_self_component_port_input_message_iterator_get_ref(
  82                 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
  83
  84 extern void bt_self_component_port_input_message_iterator_put_ref(
  85                 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
  86
  87 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
  88         do {                                                            \
  89                 bt_self_component_port_input_message_iterator_put_ref(_var); \
  90                 (_var) = NULL;                                          \
  91         } while (0)
  92
  93 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
  94         do {                                                            \
  95                 bt_self_component_port_input_message_iterator_put_ref(_var_dst); \
  96                 (_var_dst) = (_var_src);                                \
  97                 (_var_src) = NULL;                                      \
  98         } while (0)
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif /* BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */