include/babeltrace2/graph/port-output-message-iterator.h

   1 #ifndef BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
   2 #define BABELTRACE_GRAPH_PORT_OUTPUT_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_port, bt_message, bt_message_iterator,
  33  * bt_port_output_message_iterator, bt_graph, bt_port_output,
  34  * bt_message_array_const, bt_bool, __BT_UPCAST
  35  */
  36 #include <babeltrace2/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 static inline
  43 bt_message_iterator *
  44 bt_port_output_message_iterator_as_message_iterator(
  45                 bt_port_output_message_iterator *iterator)
  46 {
  47         return __BT_UPCAST(bt_message_iterator, iterator);
  48 }
  49
  50 extern bt_port_output_message_iterator *
  51 bt_port_output_message_iterator_create(
  52                 bt_graph *graph,
  53                 const bt_port_output *output_port);
  54
  55 extern bt_message_iterator_next_status
  56 bt_port_output_message_iterator_next(
  57                 bt_port_output_message_iterator *iterator,
  58                 bt_message_array_const *msgs, uint64_t *count);
  59
  60 extern bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin(
  61                 bt_port_output_message_iterator *iterator,
  62                 int64_t ns_from_origin);
  63
  64 extern bt_bool bt_port_output_message_iterator_can_seek_beginning(
  65                 bt_port_output_message_iterator *iterator);
  66
  67 extern bt_message_iterator_seek_ns_from_origin_status
  68 bt_port_output_message_iterator_seek_ns_from_origin(
  69                 bt_port_output_message_iterator *iterator,
  70                 int64_t ns_from_origin);
  71
  72 extern bt_message_iterator_seek_beginning_status
  73 bt_port_output_message_iterator_seek_beginning(
  74                 bt_port_output_message_iterator *iterator);
  75
  76 extern void bt_port_output_message_iterator_get_ref(
  77                 const bt_port_output_message_iterator *port_output_message_iterator);
  78
  79 extern void bt_port_output_message_iterator_put_ref(
  80                 const bt_port_output_message_iterator *port_output_message_iterator);
  81
  82 #define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
  83         do {                                                            \
  84                 bt_port_output_message_iterator_put_ref(_var);  \
  85                 (_var) = NULL;                                          \
  86         } while (0)
  87
  88 #define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
  89         do {                                                            \
  90                 bt_port_output_message_iterator_put_ref(_var_dst);      \
  91                 (_var_dst) = (_var_src);                                \
  92                 (_var_src) = NULL;                                      \
  93         } while (0)
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */