include/babeltrace/graph/self-notification-iterator.h

   1 #ifndef BABELTRACE_GRAPH_SELF_NOTIFICATION_ITERATOR_H
   2 #define BABELTRACE_GRAPH_SELF_NOTIFICATION_ITERATOR_H
   3
   4 /*
   5  * Copyright 2017 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  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 /* For BT_NOTIFICATION_ITERATOR_STATUS_* */
  28 #include <babeltrace/graph/notification-iterator.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct bt_self_component;
  35 struct bt_self_notification_iterator;
  36
  37 enum bt_self_notification_iterator_status {
  38         BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK = BT_NOTIFICATION_ITERATOR_STATUS_OK,
  39         BT_SELF_NOTIFICATION_ITERATOR_STATUS_END = BT_NOTIFICATION_ITERATOR_STATUS_END,
  40         BT_SELF_NOTIFICATION_ITERATOR_STATUS_AGAIN = BT_NOTIFICATION_ITERATOR_STATUS_AGAIN,
  41         BT_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
  42         BT_SELF_NOTIFICATION_ITERATOR_STATUS_NOMEM = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM,
  43 };
  44
  45 extern struct bt_self_component *
  46 bt_self_notification_iterator_borrow_component(
  47                 struct bt_self_notification_iterator *notification_iterator);
  48
  49 extern struct bt_self_port_output *
  50 bt_self_notification_iterator_borrow_port(
  51                 struct bt_self_notification_iterator *notification_iterator);
  52
  53 extern void bt_self_notification_iterator_set_data(
  54                 struct bt_self_notification_iterator *notification_iterator,
  55                 void *user_data);
  56
  57 extern void *bt_self_notification_iterator_get_data(
  58                 const struct bt_self_notification_iterator *notification_iterator);
  59
  60 #ifdef __cplusplus
  61 }
  62 #endif
  63
  64 #endif /* BABELTRACE_GRAPH_SELF_NOTIFICATION_ITERATOR_H */