[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-writer/stream-class.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_ctf_event;
struct bt_ctf_stream;

/*
 * bt_ctf_stream_append_discarded_events: increment discarded events count.
 *
 * Increase the current packet's discarded event count.
 *
 * @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.
 *
 * @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_flush: flush a stream.
 *
 * The stream's current packet's events will be flushed to disk. Events
 * subsequently appended to the stream will be added to a new packet.
 *
 * @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.
 *
 * 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	*
de9dd397	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
cf6f1e34 JG	33	#include <babeltrace/ctf-writer/stream-class.h>
cf6f1e34 JG	34
46bd0f2b JG	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
	39	struct bt_ctf_event;
46bd0f2b	40	struct bt_ctf_stream;
46bd0f2b JG	41
	42	/*
	43	* bt_ctf_stream_append_discarded_events: increment discarded events count.
	44	*
	45	* Increase the current packet's discarded event count.
	46	*
	47	* @param stream Stream instance.
	48	* @param event_count Number of discarded events to add to the stream's current
	49	* packet.
46bd0f2b JG	50	*/
	51	extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
	52	uint64_t event_count);
	53
	54	/*
	55	* bt_ctf_stream_append_event: append an event to the stream.
	56	*
	57	* Append "event" to the stream's current packet. The stream's associated clock
	58	* will be sampled during this call. The event shall not be modified after
	59	* being appended to a stream. The stream will share the event's ownership by
	60	* incrementing its reference count. The current packet is not flushed to disk
	61	* until the next call to bt_ctf_stream_flush.
	62	*
	63	* @param stream Stream instance.
	64	* @param event Event instance to append to the stream's current packet.
	65	*
	66	* Returns 0 on success, a negative value on error.
	67	*/
	68	extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
	69	struct bt_ctf_event *event);
	70
	71	/*
	72	* bt_ctf_stream_flush: flush a stream.
	73	*
	74	* The stream's current packet's events will be flushed to disk. Events
	75	* subsequently appended to the stream will be added to a new packet.
	76	*
	77	* @param stream Stream instance.
	78	*
	79	* Returns 0 on success, a negative value on error.
	80	*/
	81	extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
	82
	83	/*
	84	* bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
	85	* stream's reference count.
	86	*
	87	* These functions ensure that the stream won't be destroyed while it
	88	* is in use. The same number of get and put (plus one extra put to
	89	* release the initial reference done at creation) have to be done to
	90	* destroy a stream.
	91	*
	92	* When the stream's reference count is decremented to 0 by a
	93	* bt_ctf_stream_put, the stream is freed.
	94	*
	95	* @param stream Stream instance.
	96	*/
	97	extern void bt_ctf_stream_get(struct bt_ctf_stream *stream);
	98	extern void bt_ctf_stream_put(struct bt_ctf_stream *stream);
	99
	100	#ifdef __cplusplus
	101	}
	102	#endif
	103
	104	#endif /* BABELTRACE_CTF_WRITER_STREAM_H */