include/babeltrace/plugin/notification/schema.h

   1 #ifndef BABELTRACE_PLUGIN_NOTIFICATION_SCHEMA_H
   2 #define BABELTRACE_PLUGIN_NOTIFICATION_SCHEMA_H
   3
   4 /*
   5  * BabelTrace - Plug-in Schema Change 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_trace;
  36 struct bt_ctf_stream_class;
  37 struct bt_ctf_event_class;
  38
  39 /* BT_NOTIFICATION_TYPE_NEW_TRACE */
  40 /**
  41  * Create a new trace notification.
  42  *
  43  * @param trace                 The new trace
  44  * @returns                     A new trace notification instance
  45  *
  46  * @see #bt_notification_type
  47  */
  48 extern struct bt_notification *bt_notification_new_trace_create(
  49                 struct bt_ctf_trace *trace);
  50
  51 /**
  52  * Get a new trace notification's associated trace.
  53  *
  54  * @param notification  New trace notification instance
  55  * @returns             A trace instance
  56  *
  57  * @see #bt_ctf_trace
  58  */
  59 extern struct bt_ctf_trace *bt_notification_new_trace_get_trace(
  60                 struct bt_notification *notification);
  61
  62
  63 /* BT_NOTIFICATION_TYPE_NEW_STREAM_CLASS */
  64 /**
  65  * Create a new stream class notification.
  66  *
  67  * @param trace                 The event's trace
  68  * @returns                     A new stream class notification instance
  69  *
  70  * @see #bt_notification_type
  71  */
  72 extern struct bt_notification *bt_notification_new_stream_class_create(
  73                 struct bt_ctf_stream_class *stream_class);
  74
  75 /**
  76  * Get a new stream class notification's associated stream class.
  77  *
  78  * @param notification  New stream class notification instance
  79  * @returns             A stream class instance
  80  *
  81  * @see #bt_ctf_stream_class
  82  */
  83 extern struct bt_ctf_trace *bt_notification_new_stream_class_get_stream_class(
  84                 struct bt_notification *notification);
  85
  86
  87 /* BT_NOTIFICATION_TYPE_EVENT_CLASS */
  88 /**
  89  * Create a new trace notification.
  90  *
  91  * @param trace                 The event's trace
  92  * @returns                     An event notification instance
  93  *
  94  * @see #bt_notification_type
  95  */
  96 extern struct bt_notification *bt_notification_new_trace_create(
  97                 struct bt_ctf_trace *trace);
  98
  99 /**
 100  * Get a new trace notification's associated trace.
 101  *
 102  * @param notification  New trace notification instance
 103  * @returns             A trace instance
 104  *
 105  * @see #bt_ctf_trace
 106  */
 107 extern struct bt_ctf_trace *bt_notification_new_trace_get_trace(
 108                 struct bt_notification *notification);
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif /* BABELTRACE_PLUGIN_NOTIFICATION_SCHEMA_H */