include/babeltrace/graph/notification-stream.h

   1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_STREAM_H
   2 #define BABELTRACE_GRAPH_NOTIFICATION_STREAM_H
   3
   4 /*
   5  * BabelTrace - Plug-in Stream-related Notifications
   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 #include <stdint.h>
  31
  32 /* For bt_get() */
  33 #include <babeltrace/ref.h>
  34
  35 /* For bt_bool */
  36 #include <babeltrace/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 struct bt_notification;
  43 struct bt_clock_class;
  44 struct bt_clock_value;
  45 struct bt_stream;
  46
  47 extern
  48 struct bt_notification *bt_notification_stream_begin_create(
  49                 struct bt_graph *graph,
  50                 struct bt_stream *stream);
  51
  52 extern
  53 struct bt_notification *bt_notification_stream_end_create(
  54                 struct bt_graph *graph,
  55                 struct bt_stream *stream);
  56
  57 extern struct bt_stream *bt_notification_stream_begin_borrow_stream(
  58                 struct bt_notification *notification);
  59
  60 static inline
  61 struct bt_stream *bt_notification_stream_begin_get_stream(
  62                 struct bt_notification *notification)
  63 {
  64         return bt_get(bt_notification_stream_begin_borrow_stream(notification));
  65 }
  66
  67 extern int bt_notification_stream_begin_set_clock_value(
  68                 struct bt_notification *notif,
  69                 struct bt_clock_class *clock_class, uint64_t raw_value,
  70                 bt_bool is_default);
  71
  72 extern struct bt_clock_value *bt_notification_stream_begin_borrow_default_clock_value(
  73                 struct bt_notification *notif);
  74
  75 extern struct bt_stream *bt_notification_stream_end_borrow_stream(
  76                 struct bt_notification *notification);
  77
  78 static inline
  79 struct bt_stream *bt_notification_stream_end_get_stream(
  80                 struct bt_notification *notification)
  81 {
  82         return bt_get(bt_notification_stream_end_borrow_stream(notification));
  83 }
  84
  85 extern int bt_notification_stream_end_set_clock_value(
  86                 struct bt_notification *notif,
  87                 struct bt_clock_class *clock_class, uint64_t raw_value,
  88                 bt_bool is_default);
  89
  90 extern struct bt_clock_value *bt_notification_stream_end_borrow_default_clock_value(
  91                 struct bt_notification *notif);
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif /* BABELTRACE_GRAPH_NOTIFICATION_STREAM_H */