include/babeltrace/graph/notification-event.h

   1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_EVENT_H
   2 #define BABELTRACE_GRAPH_NOTIFICATION_EVENT_H
   3
   4 /*
   5  * BabelTrace - Plug-in Event Notification
   6  *
   7  * Copyright 2016 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 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct bt_notification;
  35 struct bt_ctf_event;
  36 struct bt_clock_class_priority_map;
  37
  38 /***BT_NOTIFICATION_TYPE_EVENT ***/
  39 /**
  40  * Create an event notification.
  41  *
  42  * @param event                 The event
  43  * @returns                     An event notification instance
  44  *
  45  * @see #bt_notification_type
  46  */
  47 extern struct bt_notification *bt_notification_event_create(
  48                 struct bt_ctf_event *event,
  49                 struct bt_clock_class_priority_map *clock_class_priority_map);
  50
  51 /**
  52  * Get an event notification's event.
  53  *
  54  * @param notification  Event notification instance
  55  * @returns             An event instance
  56  *
  57  * @see #bt_ctf_event
  58  */
  59 extern struct bt_ctf_event *bt_notification_event_get_event(
  60                 struct bt_notification *notification);
  61
  62 extern struct bt_clock_class_priority_map *
  63 bt_notification_event_get_clock_class_priority_map(
  64                 struct bt_notification *notification);
  65
  66 #ifdef __cplusplus
  67 }
  68 #endif
  69
  70 #endif /* BABELTRACE_GRAPH_NOTIFICATION_EVENT_H */