include/babeltrace/plugin/notification/notification.h

   1 #ifndef BABELTRACE_PLUGIN_NOTIFICATION_H
   2 #define BABELTRACE_PLUGIN_NOTIFICATION_H
   3
   4 /*
   5  * BabelTrace - Plug-in Notification
   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 <stdint.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct bt_notification;
  37
  38 /**
  39  * Notification types. Unhandled notification types should be ignored.
  40  */
  41 enum bt_plugin_notification_type {
  42         BT_PLUGIN_NOTIFICATION_TYPE_UNKNOWN = -1,
  43
  44         /** Event delivery notification, see event.h */
  45         BT_PLUGIN_NOTIFICATION_TYPE_EVENT = 0,
  46
  47         /** New stream packet notification, see packet.h */
  48         BT_PLUGIN_NOTIFICATION_TYPE_NEW_PACKET = 1,
  49
  50         /** End of trace notification, see eot.h */
  51         BT_PLUGIN_NOTIFICATION_TYPE_EOT = 2,
  52 };
  53
  54 /**
  55  * Get a notification's type.
  56  *
  57  * @param notification  Notification instance
  58  * @returns             One of #bt_plugin_notification_type
  59  */
  60 enum bt_plugin_notification_type bt_plugin_notification_get_type(
  61                 struct bt_plugin_notification *notification);
  62
  63 /**
  64  * Increments the reference count of \p notifiaction.
  65  *
  66  * @param notification  Notification of which to increment the reference count
  67  *
  68  * @see bt_plugin_notification_put()
  69  */
  70 void bt_plugin_notification_get(struct bt_plugin_notification *notification);
  71
  72 /**
  73  * Decrements the reference count of \p notification, destroying it when this
  74  * count reaches 0.
  75  *
  76  * @param notification  Notification of which to decrement the reference count
  77  *
  78  * @see bt_plugin_notification_get()
  79  */
  80 void bt_plugin_notification_put(struct bt_plugin_notification *notification);
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* BABELTRACE_PLUGIN_NOTIFICATION_H */