[babeltrace.git] / include / babeltrace / ctf-writer / stream-class.h

#ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_H
#define BABELTRACE_CTF_WRITER_STREAM_CLASS_H

/*
 * BabelTrace - CTF Writer: Stream Class
 *
 * Copyright 2014 EfficiOS Inc.
 *
 * Author: 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 <babeltrace/ref.h>
#include <babeltrace/ctf-ir/stream-class.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_ctf_stream_class;
struct bt_ctf_trace;
struct bt_ctf_event_class;
struct bt_ctf_field_type;
struct bt_ctf_clock;

extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(
		const char *name);

extern struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
		struct bt_ctf_stream_class *stream_class);

extern const char *bt_ctf_stream_class_get_name(
		struct bt_ctf_stream_class *stream_class);

extern int bt_ctf_stream_class_set_name(
		struct bt_ctf_stream_class *stream_class, const char *name);

extern int64_t bt_ctf_stream_class_get_id(
		struct bt_ctf_stream_class *stream_class);

extern int bt_ctf_stream_class_set_id(
		struct bt_ctf_stream_class *stream_class, uint64_t id);

extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
		struct bt_ctf_stream_class *stream_class);

extern int bt_ctf_stream_class_set_packet_context_type(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_field_type *packet_context_type);

extern struct bt_ctf_field_type *
bt_ctf_stream_class_get_event_header_type(
		struct bt_ctf_stream_class *stream_class);

extern int bt_ctf_stream_class_set_event_header_type(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_field_type *event_header_type);

extern struct bt_ctf_field_type *
bt_ctf_stream_class_get_event_context_type(
		struct bt_ctf_stream_class *stream_class);

extern int bt_ctf_stream_class_set_event_context_type(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_field_type *event_context_type);

extern int64_t bt_ctf_stream_class_get_event_class_count(
		struct bt_ctf_stream_class *stream_class);

extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_index(
		struct bt_ctf_stream_class *stream_class, uint64_t index);

extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
		struct bt_ctf_stream_class *stream_class, uint64_t id);

extern int bt_ctf_stream_class_add_event_class(
		struct bt_ctf_stream_class *stream_class,
		struct bt_ctf_event_class *event_class);

extern int bt_ctf_stream_class_set_clock(
		struct bt_ctf_stream_class *ctf_stream_class,
		struct bt_ctf_clock *clock);

extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
        struct bt_ctf_stream_class *stream_class);

/* Pre-2.0 CTF writer compatibility */
static inline
void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class)
{
	bt_get(stream_class);
}

/* Pre-2.0 CTF writer compatibility */
static inline
void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class)
{
	bt_put(stream_class);
}

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_H */
Commit	Line	Data
8c18d80b PP	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_CLASS_H
	3
cf6f1e34 JG	4	/*
	5	* BabelTrace - CTF Writer: Stream Class
	6	*
	7	* Copyright 2014 EfficiOS Inc.
	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
3dca2276	33	#include <babeltrace/ref.h>
adc315b8	34	#include <babeltrace/ctf-ir/stream-class.h>
8c18d80b PP	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
3dca2276 PP	40	struct bt_ctf_stream_class;
	41	struct bt_ctf_trace;
	42	struct bt_ctf_event_class;
	43	struct bt_ctf_field_type;
	44	struct bt_ctf_clock;
	45
	46	extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(
	47	const char *name);
	48
	49	extern struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
	50	struct bt_ctf_stream_class *stream_class);
	51
	52	extern const char *bt_ctf_stream_class_get_name(
	53	struct bt_ctf_stream_class *stream_class);
	54
	55	extern int bt_ctf_stream_class_set_name(
	56	struct bt_ctf_stream_class stream_class, const char name);
	57
	58	extern int64_t bt_ctf_stream_class_get_id(
	59	struct bt_ctf_stream_class *stream_class);
	60
	61	extern int bt_ctf_stream_class_set_id(
	62	struct bt_ctf_stream_class *stream_class, uint64_t id);
	63
	64	extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
	65	struct bt_ctf_stream_class *stream_class);
	66
	67	extern int bt_ctf_stream_class_set_packet_context_type(
	68	struct bt_ctf_stream_class *stream_class,
	69	struct bt_ctf_field_type *packet_context_type);
	70
	71	extern struct bt_ctf_field_type *
	72	bt_ctf_stream_class_get_event_header_type(
	73	struct bt_ctf_stream_class *stream_class);
	74
	75	extern int bt_ctf_stream_class_set_event_header_type(
	76	struct bt_ctf_stream_class *stream_class,
	77	struct bt_ctf_field_type *event_header_type);
	78
	79	extern struct bt_ctf_field_type *
	80	bt_ctf_stream_class_get_event_context_type(
	81	struct bt_ctf_stream_class *stream_class);
	82
	83	extern int bt_ctf_stream_class_set_event_context_type(
	84	struct bt_ctf_stream_class *stream_class,
	85	struct bt_ctf_field_type *event_context_type);
	86
	87	extern int64_t bt_ctf_stream_class_get_event_class_count(
	88	struct bt_ctf_stream_class *stream_class);
	89
	90	extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_index(
	91	struct bt_ctf_stream_class *stream_class, uint64_t index);
	92
	93	extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
	94	struct bt_ctf_stream_class *stream_class, uint64_t id);
	95
	96	extern int bt_ctf_stream_class_add_event_class(
	97	struct bt_ctf_stream_class *stream_class,
	98	struct bt_ctf_event_class *event_class);
	99
	100	extern int bt_ctf_stream_class_set_clock(
	101	struct bt_ctf_stream_class *ctf_stream_class,
72bd645e PP	102	struct bt_ctf_clock *clock);
72bd645e PP	103
3dca2276 PP	104	extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
3dca2276 PP	105	struct bt_ctf_stream_class *stream_class);
50842bdc PP	106
50842bdc PP	107	/* Pre-2.0 CTF writer compatibility */
3dca2276 PP	108	static inline
	109	void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class)
	110	{
	111	bt_get(stream_class);
	112	}
ac0c6bdd	113
3dca2276 PP	114	/* Pre-2.0 CTF writer compatibility */
	115	static inline
	116	void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class)
	117	{
	118	bt_put(stream_class);
	119	}
8c18d80b PP	120
	121	#ifdef __cplusplus
	122	}
	123	#endif
	124
	125	#endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_H */