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