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