include/babeltrace/ctf-ir/event-class.h

   1 #ifndef BABELTRACE_CTF_IR_EVENT_CLASS_H
   2 #define BABELTRACE_CTF_IR_EVENT_CLASS_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Event class
   6  *
   7  * Copyright 2013, 2014 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  * The Common Trace Format (CTF) Specification is available at
  30  * http://www.efficios.com/ctf
  31  */
  32
  33 /* For enum bt_property_availability */
  34 #include <babeltrace/property.h>
  35
  36 #include <stdint.h>
  37 #include <stddef.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct bt_event_class;
  44 struct bt_field_type;
  45 struct bt_stream_class;
  46
  47 enum bt_event_class_log_level {
  48         BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY,
  49         BT_EVENT_CLASS_LOG_LEVEL_ALERT,
  50         BT_EVENT_CLASS_LOG_LEVEL_CRITICAL,
  51         BT_EVENT_CLASS_LOG_LEVEL_ERROR,
  52         BT_EVENT_CLASS_LOG_LEVEL_WARNING,
  53         BT_EVENT_CLASS_LOG_LEVEL_NOTICE,
  54         BT_EVENT_CLASS_LOG_LEVEL_INFO,
  55         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM,
  56         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM,
  57         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS,
  58         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE,
  59         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT,
  60         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION,
  61         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE,
  62         BT_EVENT_CLASS_LOG_LEVEL_DEBUG,
  63 };
  64
  65 extern struct bt_event_class *bt_event_class_create(
  66                 struct bt_stream_class *stream_class);
  67
  68 extern struct bt_event_class *bt_event_class_create_with_id(
  69                 struct bt_stream_class *stream_class, uint64_t id);
  70
  71 extern struct bt_stream_class *bt_event_class_borrow_stream_class(
  72                 struct bt_event_class *event_class);
  73
  74 extern const char *bt_event_class_get_name(struct bt_event_class *event_class);
  75
  76 extern int bt_event_class_set_name(struct bt_event_class *event_class,
  77                 const char *name);
  78
  79 extern uint64_t bt_event_class_get_id(struct bt_event_class *event_class);
  80
  81 extern enum bt_property_availability bt_event_class_get_log_level(
  82                 struct bt_event_class *event_class,
  83                 enum bt_event_class_log_level *log_level);
  84
  85 extern int bt_event_class_set_log_level(struct bt_event_class *event_class,
  86                 enum bt_event_class_log_level log_level);
  87
  88 extern const char *bt_event_class_get_emf_uri(
  89                 struct bt_event_class *event_class);
  90
  91 extern int bt_event_class_set_emf_uri(struct bt_event_class *event_class,
  92                 const char *emf_uri);
  93
  94 extern struct bt_field_type *bt_event_class_borrow_specific_context_field_type(
  95                 struct bt_event_class *event_class);
  96
  97 extern int bt_event_class_set_specific_context_field_type(
  98                 struct bt_event_class *event_class,
  99                 struct bt_field_type *field_type);
 100
 101 extern struct bt_field_type *bt_event_class_borrow_payload_field_type(
 102                 struct bt_event_class *event_class);
 103
 104 extern int bt_event_class_set_payload_field_type(
 105                 struct bt_event_class *event_class,
 106                 struct bt_field_type *field_type);
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif /* BABELTRACE_CTF_IR_EVENT_CLASS_H */