include/babeltrace/graph/notification-iterator.h

   1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
   2 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
   3
   4 /*
   5  * BabelTrace - Notification Iterator
   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 /* For bt_object_get_ref() */
  31 #include <babeltrace/object.h>
  32
  33 #include <stdint.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_notification;
  40 struct bt_notification_iterator;
  41
  42 /**
  43  * Status code. Errors are always negative.
  44  */
  45 enum bt_notification_iterator_status {
  46         /** Canceled. */
  47         BT_NOTIFICATION_ITERATOR_STATUS_CANCELED = 125,
  48         /** No notifications available for now. Try again later. */
  49         BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11,
  50         /** No more notifications to be delivered. */
  51         BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
  52         /** No error, okay. */
  53         BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
  54         /** Invalid arguments. */
  55         BT_NOTIFICATION_ITERATOR_STATUS_INVALID = -22,
  56         /** General error. */
  57         BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -1,
  58         /** Out of memory. */
  59         BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -12,
  60         /** Unsupported iterator feature. */
  61         BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -2,
  62 };
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H */