[babeltrace.git] / include / babeltrace / ctf-ir / event-class.h

#ifndef BABELTRACE_CTF_IR_EVENT_CLASS_H
#define BABELTRACE_CTF_IR_EVENT_CLASS_H

/*
 * BabelTrace - CTF IR: Event class
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * 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 <stdint.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_ctf_event_class;
struct bt_ctf_field;
struct bt_ctf_field_type;
struct bt_ctf_stream_class;

/*
 * bt_ctf_event_class_create: create an event class.
 *
 * Allocate a new event class of the given name. The creation of an event class
 * sets its reference count to 1. A unique event id is automatically assigned
 * to the event class.
 *
 * @param name Event class name (will be copied).
 *
 * Returns an allocated event class on success, NULL on error.
 */
extern struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name);

/*
 * bt_ctf_event_class_add_field: add a field to an event class.
 *
 * Add a field of type "type" to the event class. The event class will share
 * type's ownership by increasing its reference count. The "name" will be
 * copied.
 *
 * @param event_class Event class.
 * @param type Field type to add to the event class.
 * @param name Name of the new field.
 *
 * Returns 0 on success, a negative value on error.
 *
 * Note: Returns an error if the payload is not a structure.
 */
extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
		struct bt_ctf_field_type *type,
		const char *name);

/*
 * bt_ctf_event_class_get_field_by_name: Get an event class's field by name
 *
 * @param event_class Event class.
 * @param name Name of the field.
 *
 * Returns a field type on success, NULL on error.
 *
 * Note: Returns an error if the payload is not a structure.
 */
extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
		struct bt_ctf_event_class *event_class, const char *name);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_IR_EVENT_CLASS_H */
Commit	Line	Data
1c822dfb JG	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	#include <stdint.h>
	34	#include <stddef.h>
1c822dfb JG	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
	40	struct bt_ctf_event_class;
	41	struct bt_ctf_field;
	42	struct bt_ctf_field_type;
	43	struct bt_ctf_stream_class;
	44
	45	/*
	46	* bt_ctf_event_class_create: create an event class.
	47	*
	48	* Allocate a new event class of the given name. The creation of an event class
	49	* sets its reference count to 1. A unique event id is automatically assigned
	50	* to the event class.
	51	*
	52	* @param name Event class name (will be copied).
	53	*
	54	* Returns an allocated event class on success, NULL on error.
	55	*/
	56	extern struct bt_ctf_event_class bt_ctf_event_class_create(const char name);
	57
1c822dfb JG	58	/*
	59	* bt_ctf_event_class_add_field: add a field to an event class.
	60	*
	61	* Add a field of type "type" to the event class. The event class will share
	62	* type's ownership by increasing its reference count. The "name" will be
	63	* copied.
	64	*
	65	* @param event_class Event class.
	66	* @param type Field type to add to the event class.
	67	* @param name Name of the new field.
	68	*
	69	* Returns 0 on success, a negative value on error.
	70	*
	71	* Note: Returns an error if the payload is not a structure.
	72	*/
	73	extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
	74	struct bt_ctf_field_type *type,
	75	const char *name);
	76
	77	/*
55667b40	78	* bt_ctf_event_class_get_field_by_name: Get an event class's field by name
1c822dfb JG	79	*
	80	* @param event_class Event class.
	81	* @param name Name of the field.
	82	*
	83	* Returns a field type on success, NULL on error.
	84	*
	85	* Note: Returns an error if the payload is not a structure.
	86	*/
	87	extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
	88	struct bt_ctf_event_class event_class, const char name);
	89
1c822dfb JG	90	#ifdef __cplusplus
	91	}
	92	#endif
	93
	94	#endif /* BABELTRACE_CTF_IR_EVENT_CLASS_H */