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

   1 #ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31
  32 /* For bt_message_iterator_*_status */
  33 #include <babeltrace2/graph/message-iterator.h>
  34
  35 /*
  36  * For bt_component, bt_message_iterator,
  37  * bt_self_component_port_input_message_iterator,
  38  * bt_self_component_port_input, bt_message_array_const, bt_bool,
  39  * __BT_UPCAST
  40  */
  41 #include <babeltrace2/types.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 static inline
  48 bt_message_iterator *
  49 bt_self_component_port_input_message_iterator_as_message_iterator(
  50                 bt_self_component_port_input_message_iterator *iterator)
  51 {
  52         return __BT_UPCAST(bt_message_iterator, iterator);
  53 }
  54
  55 extern bt_self_component_port_input_message_iterator *
  56 bt_self_component_port_input_message_iterator_create(
  57                 bt_self_component_port_input *input_port);
  58
  59 extern bt_component *
  60 bt_self_component_port_input_message_iterator_borrow_component(
  61                 bt_self_component_port_input_message_iterator *iterator);
  62
  63 extern bt_message_iterator_next_status
  64 bt_self_component_port_input_message_iterator_next(
  65                 bt_self_component_port_input_message_iterator *iterator,
  66                 bt_message_array_const *msgs, uint64_t *count);
  67
  68 extern bt_bool
  69 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
  70                 bt_self_component_port_input_message_iterator *iterator,
  71                 int64_t ns_from_origin);
  72
  73 extern bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
  74                 bt_self_component_port_input_message_iterator *iterator);
  75
  76 extern bt_message_iterator_seek_ns_from_origin_status
  77 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
  78                 bt_self_component_port_input_message_iterator *iterator,
  79                 int64_t ns_from_origin);
  80
  81 extern bt_message_iterator_seek_beginning_status
  82 bt_self_component_port_input_message_iterator_seek_beginning(
  83                 bt_self_component_port_input_message_iterator *iterator);
  84
  85 extern void bt_self_component_port_input_message_iterator_get_ref(
  86                 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
  87
  88 extern void bt_self_component_port_input_message_iterator_put_ref(
  89                 const bt_self_component_port_input_message_iterator *self_component_port_input_message_iterator);
  90
  91 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
  92         do {                                                            \
  93                 bt_self_component_port_input_message_iterator_put_ref(_var); \
  94                 (_var) = NULL;                                          \
  95         } while (0)
  96
  97 #define BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
  98         do {                                                            \
  99                 bt_self_component_port_input_message_iterator_put_ref(_var_dst); \
 100                 (_var_dst) = (_var_src);                                \
 101                 (_var_src) = NULL;                                      \
 102         } while (0)
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */