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

#ifndef BABELTRACE2_TRACE_IR_STREAM_CLASS_H
#define BABELTRACE2_TRACE_IR_STREAM_CLASS_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#include <stdint.h>

#include <babeltrace2/types.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);

typedef enum bt_stream_class_set_name_status {
	BT_STREAM_CLASS_SET_NAME_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_STREAM_CLASS_SET_NAME_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_stream_class_set_name_status;

extern bt_stream_class_set_name_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 void bt_stream_class_set_supports_discarded_events(
		bt_stream_class *stream_class,
		bt_bool supports_discarded_events,
		bt_bool with_default_clock_snapshots);

extern void bt_stream_class_set_supports_discarded_packets(
		bt_stream_class *stream_class,
		bt_bool supports_discarded_packets,
		bt_bool with_default_clock_snapshots);

typedef enum bt_stream_class_set_field_class_status {
	BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_stream_class_set_field_class_status;

extern void bt_stream_class_set_supports_packets(
		bt_stream_class *stream_class, bt_bool supports_packets,
		bt_bool with_beginning_default_clock_snapshot,
		bt_bool with_end_default_clock_snapshot);

extern bt_stream_class_set_field_class_status
bt_stream_class_set_packet_context_field_class(
		bt_stream_class *stream_class,
		bt_field_class *field_class);

extern bt_field_class *
bt_stream_class_borrow_packet_context_field_class(
		bt_stream_class *stream_class);

extern bt_stream_class_set_field_class_status
bt_stream_class_set_event_common_context_field_class(
		bt_stream_class *stream_class,
		bt_field_class *field_class);

extern bt_field_class *
bt_stream_class_borrow_event_common_context_field_class(
		bt_stream_class *stream_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);

typedef enum bt_stream_class_set_default_clock_class_status {
	BT_STREAM_CLASS_SET_DEFAULT_CLOCK_CLASS_STATUS_OK	= __BT_FUNC_STATUS_OK,
} bt_stream_class_set_default_clock_class_status;

extern bt_stream_class_set_default_clock_class_status
bt_stream_class_set_default_clock_class(
		bt_stream_class *stream_class,
		bt_clock_class *clock_class);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_TRACE_IR_STREAM_CLASS_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_TRACE_IR_STREAM_CLASS_H
	2	#define BABELTRACE2_TRACE_IR_STREAM_CLASS_H
	3
	4	/*
	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
	30	#include <stdint.h>
	31
	32	#include <babeltrace2/types.h>
	33
	34	#ifdef __cplusplus
	35	extern "C" {
	36	#endif
	37
	38	extern bt_stream_class *bt_stream_class_create(
	39	bt_trace_class *trace_class);
	40
	41	extern bt_stream_class *bt_stream_class_create_with_id(
	42	bt_trace_class *trace_class, uint64_t id);
	43
	44	extern bt_trace_class *bt_stream_class_borrow_trace_class(
	45	bt_stream_class *stream_class);
	46
	47	typedef enum bt_stream_class_set_name_status {
	48	BT_STREAM_CLASS_SET_NAME_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	49	BT_STREAM_CLASS_SET_NAME_STATUS_OK = __BT_FUNC_STATUS_OK,
	50	} bt_stream_class_set_name_status;
	51
	52	extern bt_stream_class_set_name_status bt_stream_class_set_name(
	53	bt_stream_class stream_class, const char name);
	54
	55	extern void bt_stream_class_set_assigns_automatic_event_class_id(
	56	bt_stream_class *stream_class, bt_bool value);
	57
	58	extern void bt_stream_class_set_assigns_automatic_stream_id(
	59	bt_stream_class *stream_class, bt_bool value);
	60
	61	extern void bt_stream_class_set_supports_discarded_events(
	62	bt_stream_class *stream_class,
	63	bt_bool supports_discarded_events,
	64	bt_bool with_default_clock_snapshots);
	65
	66	extern void bt_stream_class_set_supports_discarded_packets(
	67	bt_stream_class *stream_class,
	68	bt_bool supports_discarded_packets,
	69	bt_bool with_default_clock_snapshots);
	70
	71	typedef enum bt_stream_class_set_field_class_status {
	72	BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	73	BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
	74	} bt_stream_class_set_field_class_status;
	75
	76	extern void bt_stream_class_set_supports_packets(
	77	bt_stream_class *stream_class, bt_bool supports_packets,
	78	bt_bool with_beginning_default_clock_snapshot,
	79	bt_bool with_end_default_clock_snapshot);
	80
	81	extern bt_stream_class_set_field_class_status
	82	bt_stream_class_set_packet_context_field_class(
	83	bt_stream_class *stream_class,
	84	bt_field_class *field_class);
	85
	86	extern bt_field_class *
	87	bt_stream_class_borrow_packet_context_field_class(
	88	bt_stream_class *stream_class);
	89
	90	extern bt_stream_class_set_field_class_status
	91	bt_stream_class_set_event_common_context_field_class(
	92	bt_stream_class *stream_class,
	93	bt_field_class *field_class);
	94
	95	extern bt_field_class *
	96	bt_stream_class_borrow_event_common_context_field_class(
	97	bt_stream_class *stream_class);
	98
	99	extern bt_event_class *
	100	bt_stream_class_borrow_event_class_by_index(
	101	bt_stream_class *stream_class, uint64_t index);
	102
	103	extern bt_event_class *
	104	bt_stream_class_borrow_event_class_by_id(
	105	bt_stream_class *stream_class, uint64_t id);
	106
	107	extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
	108	bt_stream_class *stream_class);
	109
	110	typedef enum bt_stream_class_set_default_clock_class_status {
	111	BT_STREAM_CLASS_SET_DEFAULT_CLOCK_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
	112	} bt_stream_class_set_default_clock_class_status;
	113
	114	extern bt_stream_class_set_default_clock_class_status
	115	bt_stream_class_set_default_clock_class(
	116	bt_stream_class *stream_class,
	117	bt_clock_class *clock_class);
	118
	119	#ifdef __cplusplus
	120	}
	121	#endif
	122
	123	#endif /* BABELTRACE2_TRACE_IR_STREAM_CLASS_H */