[babeltrace.git] / include / babeltrace / trace-ir / stream-class.h

#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_H
#define BABELTRACE_TRACE_IR_STREAM_CLASS_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#include <stdint.h>

/*
 * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
 * bt_clock_class
 */
#include <babeltrace/types.h>

/* For enum bt_stream_class_status */
#include <babeltrace/trace-ir/stream-class-const.h>

#ifdef __cplusplus
extern "C" {
#endif

extern bt_stream_class *bt_stream_class_create(
		bt_trace_class *trace_class);

extern bt_stream_class *bt_stream_class_create_with_id(
		bt_trace_class *trace_class, uint64_t id);

extern bt_trace_class *bt_stream_class_borrow_trace_class(
		bt_stream_class *stream_class);

extern enum bt_stream_class_status bt_stream_class_set_name(
		bt_stream_class *stream_class, const char *name);

extern void bt_stream_class_set_assigns_automatic_event_class_id(
		bt_stream_class *stream_class, bt_bool value);

extern void bt_stream_class_set_assigns_automatic_stream_id(
		bt_stream_class *stream_class, bt_bool value);

extern enum bt_stream_class_status
bt_stream_class_set_packet_context_field_class(
		bt_stream_class *stream_class,
		bt_field_class *field_class);

extern enum bt_stream_class_status
bt_stream_class_set_event_header_field_class(
		bt_stream_class *stream_class,
		bt_field_class *field_class);

extern enum bt_stream_class_status
bt_stream_class_set_event_common_context_field_class(
		bt_stream_class *stream_class,
		bt_field_class *field_class);

extern bt_event_class *
bt_stream_class_borrow_event_class_by_index(
		bt_stream_class *stream_class, uint64_t index);

extern bt_event_class *
bt_stream_class_borrow_event_class_by_id(
		bt_stream_class *stream_class, uint64_t id);

extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
		bt_stream_class *stream_class);

extern enum bt_stream_class_status bt_stream_class_set_default_clock_class(
		bt_stream_class *stream_class,
		bt_clock_class *clock_class);

extern void
bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
		bt_stream_class *stream_class, bt_bool value);

extern void
bt_stream_class_set_packets_have_packet_counter_snapshot(
		bt_stream_class *stream_class, bt_bool value);

extern void
bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
		bt_stream_class *stream_class, bt_bool value);

extern void
bt_stream_class_set_packets_have_default_end_clock_snapshot(
		bt_stream_class *stream_class, bt_bool value);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_H
	2	#define BABELTRACE_TRACE_IR_STREAM_CLASS_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 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	#include <stdint.h>
	31
	32	/*
	33	* For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
	34	* bt_clock_class
	35	*/
	36	#include <babeltrace/types.h>
	37
	38	/* For enum bt_stream_class_status */
	39	#include <babeltrace/trace-ir/stream-class-const.h>
	40
	41	#ifdef __cplusplus
	42	extern "C" {
	43	#endif
	44
	45	extern bt_stream_class *bt_stream_class_create(
	46	bt_trace_class *trace_class);
	47
	48	extern bt_stream_class *bt_stream_class_create_with_id(
	49	bt_trace_class *trace_class, uint64_t id);
	50
	51	extern bt_trace_class *bt_stream_class_borrow_trace_class(
	52	bt_stream_class *stream_class);
	53
	54	extern enum bt_stream_class_status bt_stream_class_set_name(
	55	bt_stream_class stream_class, const char name);
	56
	57	extern void bt_stream_class_set_assigns_automatic_event_class_id(
	58	bt_stream_class *stream_class, bt_bool value);
	59
	60	extern void bt_stream_class_set_assigns_automatic_stream_id(
	61	bt_stream_class *stream_class, bt_bool value);
	62
	63	extern enum bt_stream_class_status
	64	bt_stream_class_set_packet_context_field_class(
	65	bt_stream_class *stream_class,
	66	bt_field_class *field_class);
	67
	68	extern enum bt_stream_class_status
	69	bt_stream_class_set_event_header_field_class(
	70	bt_stream_class *stream_class,
	71	bt_field_class *field_class);
	72
	73	extern enum bt_stream_class_status
	74	bt_stream_class_set_event_common_context_field_class(
	75	bt_stream_class *stream_class,
	76	bt_field_class *field_class);
	77
	78	extern bt_event_class *
	79	bt_stream_class_borrow_event_class_by_index(
	80	bt_stream_class *stream_class, uint64_t index);
	81
	82	extern bt_event_class *
	83	bt_stream_class_borrow_event_class_by_id(
	84	bt_stream_class *stream_class, uint64_t id);
	85
	86	extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
	87	bt_stream_class *stream_class);
	88
	89	extern enum bt_stream_class_status bt_stream_class_set_default_clock_class(
	90	bt_stream_class *stream_class,
	91	bt_clock_class *clock_class);
	92
	93	extern void
	94	bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
	95	bt_stream_class *stream_class, bt_bool value);
	96
	97	extern void
	98	bt_stream_class_set_packets_have_packet_counter_snapshot(
	99	bt_stream_class *stream_class, bt_bool value);
	100
	101	extern void
	102	bt_stream_class_set_packets_have_default_beginning_clock_snapshot(
	103	bt_stream_class *stream_class, bt_bool value);
	104
	105	extern void
	106	bt_stream_class_set_packets_have_default_end_clock_snapshot(
	107	bt_stream_class *stream_class, bt_bool value);
	108
	109	#ifdef __cplusplus
	110	}
	111	#endif
	112
	113	#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_H */