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

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