include/babeltrace/component/notification/iterator-internal.h

   1 #ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Notification Iterator Internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/babeltrace-internal.h>
  31 #include <babeltrace/ref-internal.h>
  32 #include <babeltrace/component/notification/iterator.h>
  33
  34 struct bt_notification_iterator {
  35         struct bt_object base;
  36         struct bt_component *component;
  37         bt_notification_iterator_get_cb get;
  38         bt_notification_iterator_next_cb next;
  39         bt_notification_iterator_seek_time_cb seek_time;
  40         void *user_data;
  41         bt_notification_iterator_destroy_cb user_destroy;
  42 };
  43
  44 /**
  45  * Allocate a notification iterator.
  46  *
  47  * @param component             Component instance
  48  * @returns                     A notification iterator instance
  49  */
  50 BT_HIDDEN
  51 struct bt_notification_iterator *bt_notification_iterator_create(
  52                 struct bt_component *component);
  53
  54 /**
  55  * Validate a notification iterator.
  56  *
  57  * @param iterator              Notification iterator instance
  58  * @returns                     One of #bt_component_status values
  59  */
  60 BT_HIDDEN
  61 enum bt_notification_iterator_status bt_notification_iterator_validate(
  62                 struct bt_notification_iterator *iterator);
  63
  64 #endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */