include/babeltrace2/graph/self-message-iterator.h

   1 #ifndef BABELTRACE_GRAPH_SELF_MESSAGE_ITERATOR_H
   2 #define BABELTRACE_GRAPH_SELF_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 /* For BT_MESSAGE_ITERATOR_STATUS_* */
  27 #include <babeltrace2/graph/message-iterator-const.h>
  28
  29 /* For bt_self_component, bt_self_message_iterator, bt_self_port_output */
  30 #include <babeltrace2/types.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef enum bt_self_message_iterator_status {
  37         BT_SELF_MESSAGE_ITERATOR_STATUS_OK = BT_MESSAGE_ITERATOR_STATUS_OK,
  38         BT_SELF_MESSAGE_ITERATOR_STATUS_END = BT_MESSAGE_ITERATOR_STATUS_END,
  39         BT_SELF_MESSAGE_ITERATOR_STATUS_AGAIN = BT_MESSAGE_ITERATOR_STATUS_AGAIN,
  40         BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR = BT_MESSAGE_ITERATOR_STATUS_ERROR,
  41         BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM = BT_MESSAGE_ITERATOR_STATUS_NOMEM,
  42 } bt_self_message_iterator_status;
  43
  44 extern bt_self_component *
  45 bt_self_message_iterator_borrow_component(
  46                 bt_self_message_iterator *message_iterator);
  47
  48 extern bt_self_port_output *
  49 bt_self_message_iterator_borrow_port(
  50                 bt_self_message_iterator *message_iterator);
  51
  52 extern void bt_self_message_iterator_set_data(
  53                 bt_self_message_iterator *message_iterator,
  54                 void *user_data);
  55
  56 extern void *bt_self_message_iterator_get_data(
  57                 const bt_self_message_iterator *message_iterator);
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62
  63 #endif /* BABELTRACE_GRAPH_SELF_MESSAGE_ITERATOR_H */