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

#ifndef BABELTRACE_CTF_WRITER_STREAM_H
#define BABELTRACE_CTF_WRITER_STREAM_H

/*
 * BabelTrace - CTF Writer: Stream
 *
 * 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 <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-writer/stream-class.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * bt_ctf_stream_append_discarded_events: increment discarded events count.
 *
 * Increase the current packet's discarded event count. Has no effect if the
 * stream class' packet context has no "events_discarded" field.
 *
 * @param stream Stream instance.
 * @param event_count Number of discarded events to add to the stream's current
 *	packet.
 */
extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
		uint64_t event_count);

/*
 * bt_ctf_stream_append_event: append an event to the stream.
 *
 * Append "event" to the stream's current packet. The stream's associated clock
 * will be sampled during this call. The event shall not be modified after
 * being appended to a stream. The stream will share the event's ownership by
 * incrementing its reference count. The current packet is not flushed to disk
 * until the next call to bt_ctf_stream_flush.
 *
 * The stream event context will be sampled for every appended event if
 * a stream event context was defined.
 *
 * @param stream Stream instance.
 * @param event Event instance to append to the stream's current packet.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
		struct bt_ctf_event *event);

/*
 * bt_ctf_stream_get_packet_context: get a stream's packet context.
 *
 * @param stream Stream instance.
 *
 * Returns a field instance on success, NULL on error.
 */
extern struct bt_ctf_field *bt_ctf_stream_get_packet_context(
		struct bt_ctf_stream *stream);

/*
 * bt_ctf_stream_flush: flush a stream.
 *
 * The stream's current packet's events will be flushed, thus closing the
 * current packet. Events subsequently appended to the stream will be
 * added to a new packet.
 *
 * Flushing will also set the packet context's default attributes if
 * they remained unset while populating the current packet. These default
 * attributes, along with their expected types, are detailed in stream-class.h.
 *
 * @param stream Stream instance.
 *
 * Returns 0 on success, a negative value on error.
 */
extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);

/*
 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
 * stream's reference count.
 *
 * You may also use bt_ctf_get() and bt_ctf_put() with stream objects.
 *
 * These functions ensure that the stream won't be destroyed while it
 * is in use. The same number of get and put (plus one extra put to
 * release the initial reference done at creation) have to be done to
 * destroy a stream.
 *
 * When the stream's reference count is decremented to 0 by a
 * bt_ctf_stream_put, the stream is freed.
 *
 * @param stream Stream instance.
 */
extern void bt_ctf_stream_get(struct bt_ctf_stream *stream);
extern void bt_ctf_stream_put(struct bt_ctf_stream *stream);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_WRITER_STREAM_H */
Commit	Line	Data
46bd0f2b JG	1	#ifndef BABELTRACE_CTF_WRITER_STREAM_H
	2	#define BABELTRACE_CTF_WRITER_STREAM_H
	3
	4	/*
	5	* BabelTrace - CTF Writer: Stream
	6	*
1c822dfb	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
46bd0f2b JG	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
1c822dfb JG	33	#include <babeltrace/ctf-ir/stream.h>
	34	#include <babeltrace/ctf-writer/stream-class.h>
	35
46bd0f2b JG	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
46bd0f2b	40	/*
1c822dfb	41	* bt_ctf_stream_append_discarded_events: increment discarded events count.
46bd0f2b	42	*
1c822dfb JG	43	* Increase the current packet's discarded event count. Has no effect if the
1c822dfb JG	44	* stream class' packet context has no "events_discarded" field.
46bd0f2b	45	*
1c822dfb JG	46	* @param stream Stream instance.
	47	* @param event_count Number of discarded events to add to the stream's current
	48	* packet.
46bd0f2b	49	*/
1c822dfb JG	50	extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
1c822dfb JG	51	uint64_t event_count);
46bd0f2b JG	52
46bd0f2b JG	53	/*
1c822dfb	54	* bt_ctf_stream_append_event: append an event to the stream.
46bd0f2b	55	*
1c822dfb JG	56	* Append "event" to the stream's current packet. The stream's associated clock
	57	* will be sampled during this call. The event shall not be modified after
	58	* being appended to a stream. The stream will share the event's ownership by
	59	* incrementing its reference count. The current packet is not flushed to disk
	60	* until the next call to bt_ctf_stream_flush.
	61	*
	62	* The stream event context will be sampled for every appended event if
	63	* a stream event context was defined.
46bd0f2b	64	*
1c822dfb JG	65	* @param stream Stream instance.
1c822dfb JG	66	* @param event Event instance to append to the stream's current packet.
46bd0f2b JG	67	*
	68	* Returns 0 on success, a negative value on error.
	69	*/
1c822dfb JG	70	extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
1c822dfb JG	71	struct bt_ctf_event *event);
46bd0f2b	72
46bd0f2b	73	/*
1c822dfb	74	* bt_ctf_stream_get_packet_context: get a stream's packet context.
46bd0f2b	75	*
1c822dfb JG	76	* @param stream Stream instance.
	77	*
	78	* Returns a field instance on success, NULL on error.
	79	*/
	80	extern struct bt_ctf_field *bt_ctf_stream_get_packet_context(
	81	struct bt_ctf_stream *stream);
	82
46bd0f2b JG	83	/*
	84	* bt_ctf_stream_flush: flush a stream.
	85	*
1c822dfb JG	86	* The stream's current packet's events will be flushed, thus closing the
	87	* current packet. Events subsequently appended to the stream will be
	88	* added to a new packet.
	89	*
	90	* Flushing will also set the packet context's default attributes if
	91	* they remained unset while populating the current packet. These default
	92	* attributes, along with their expected types, are detailed in stream-class.h.
46bd0f2b JG	93	*
	94	* @param stream Stream instance.
	95	*
	96	* Returns 0 on success, a negative value on error.
	97	*/
	98	extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
	99
	100	/*
	101	* bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
	102	* stream's reference count.
	103	*
1c822dfb JG	104	* You may also use bt_ctf_get() and bt_ctf_put() with stream objects.
1c822dfb JG	105	*
46bd0f2b JG	106	* These functions ensure that the stream won't be destroyed while it
	107	* is in use. The same number of get and put (plus one extra put to
	108	* release the initial reference done at creation) have to be done to
	109	* destroy a stream.
	110	*
	111	* When the stream's reference count is decremented to 0 by a
	112	* bt_ctf_stream_put, the stream is freed.
	113	*
	114	* @param stream Stream instance.
	115	*/
	116	extern void bt_ctf_stream_get(struct bt_ctf_stream *stream);
	117	extern void bt_ctf_stream_put(struct bt_ctf_stream *stream);
	118
	119	#ifdef __cplusplus
	120	}
	121	#endif
	122
	123	#endif /* BABELTRACE_CTF_WRITER_STREAM_H */