include/babeltrace/trace-ir/event-const.h

   1 #ifndef BABELTRACE_TRACE_IR_EVENT_CONST_H
   2 #define BABELTRACE_TRACE_IR_EVENT_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 /* For enum bt_clock_snapshot_state */
  31 #include <babeltrace/trace-ir/clock-snapshot-const.h>
  32
  33 /* For bt_event, bt_clock_snapshot, bt_event_class, bt_field, bt_packet */
  34 #include <babeltrace/types.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 enum bt_event_status {
  41         BT_EVENT_STATUS_OK = 0,
  42         BT_EVENT_STATUS_NOMEM = -12,
  43 };
  44
  45 extern const bt_event_class *bt_event_borrow_class_const(
  46                 const bt_event *event);
  47
  48 extern const bt_packet *bt_event_borrow_packet_const(
  49                 const bt_event *event);
  50
  51 extern const bt_stream *bt_event_borrow_stream_const(
  52                 const bt_event *event);
  53
  54 extern const bt_field *bt_event_borrow_header_field_const(
  55                 const bt_event *event);
  56
  57 extern const bt_field *bt_event_borrow_common_context_field_const(
  58                 const bt_event *event);
  59
  60 extern const bt_field *bt_event_borrow_specific_context_field_const(
  61                 const bt_event *event);
  62
  63 extern const bt_field *bt_event_borrow_payload_field_const(
  64                 const bt_event *event);
  65
  66 extern enum bt_clock_snapshot_state bt_event_borrow_default_clock_snapshot_const(
  67                 const bt_event *event,
  68                 const bt_clock_snapshot **clock_snapshot);
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 #endif /* BABELTRACE_TRACE_IR_EVENT_CONST_H */