lib: add internal object pool API and use it; adapt plugins/tests
[babeltrace.git] / include / babeltrace / babeltrace.h
index dfe6112d0b9747e5c021fd9ceb1dd3231dcabbec..cd910280777577f8f879f35c0f8f1b6ce6c79124 100644 (file)
@@ -1,10 +1,10 @@
-#ifndef _BABELTRACE_H
-#define _BABELTRACE_H
+#ifndef BABELTRACE_BABELTRACE_H
+#define BABELTRACE_BABELTRACE_H
 
 /*
- * BabelTrace API
+ * Babeltrace API
  *
- * Copyright 2010-2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2010-2017 EfficiOS Inc. <http://www.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
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- */
-
-/* Forward declarations */
-struct babeltrace_iter;
-struct trace_collection;
-struct ctf_stream_event;
-struct ctf_stream;
-
-/*
- * babeltrace_iter_create - Allocate a trace collection iterator.
- */
-struct babeltrace_iter *babeltrace_iter_create(struct trace_collection *tc);
-
-/*
- * babeltrace_iter_destroy - Free a trace collection iterator.
- */
-void babeltrace_iter_destroy(struct babeltrace_iter *iter);
-
-/*
- * babeltrace_iter_next: Move trace collection position to the next event.
  *
- * Returns 0 on success, a negative value on error
+ * 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.
  */
-int babeltrace_iter_next(struct babeltrace_iter *iter);
 
-/*
- * babeltrace_iter_get_pos - Get the current trace collection position.
- *
- * The position returned by this function needs to be freed by
- * babeltrace_iter_free_pos after use.
- */
-struct babeltrace_iter_pos *
-       babeltrace_iter_get_pos(struct babeltrace_iter *iter);
+/* Core API */
+#include <babeltrace/logging.h>
+#include <babeltrace/ref.h>
+#include <babeltrace/types.h>
+#include <babeltrace/values.h>
+#include <babeltrace/version.h>
 
-/*
- * babeltrace_iter_free_pos - Free the position.
- */
-void babeltrace_iter_free_pos(struct babeltrace_iter_pos *pos);
+/* Legacy API (for CTF writer) */
+#include <babeltrace/ctf/events.h>
 
-/*
- * babeltrace_iter_seek_pos - Seek the trace collection to the position.
- */
-int babeltrace_iter_seek_pos(struct babeltrace_iter *iter,
-               struct babeltrace_iter_pos *pos);
+/* CTF writer API */
+#include <babeltrace/ctf-writer/clock-class.h>
+#include <babeltrace/ctf-writer/clock.h>
+#include <babeltrace/ctf-writer/event-fields.h>
+#include <babeltrace/ctf-writer/event-types.h>
+#include <babeltrace/ctf-writer/event.h>
+#include <babeltrace/ctf-writer/field-types.h>
+#include <babeltrace/ctf-writer/fields.h>
+#include <babeltrace/ctf-writer/stream-class.h>
+#include <babeltrace/ctf-writer/stream.h>
+#include <babeltrace/ctf-writer/trace.h>
+#include <babeltrace/ctf-writer/writer.h>
 
-/*
- * babeltrace_iter_seek_time: Seek the trace collection to the given timestamp.
- *
- * Return EOF if timestamp is after the last event of the trace collection.
- * Return other negative value for other errors.
- * Return 0 for success.
- */
-int babeltrace_iter_seek_time(struct babeltrace_iter *iter,
-               uint64_t timestamp);
+/* CTF IR API */
+#include <babeltrace/ctf-ir/clock-class.h>
+#include <babeltrace/ctf-ir/clock-value.h>
+#include <babeltrace/ctf-ir/clock.h>
+#include <babeltrace/ctf-ir/event-class.h>
+#include <babeltrace/ctf-ir/event-header-field.h>
+#include <babeltrace/ctf-ir/event.h>
+#include <babeltrace/ctf-ir/field-path.h>
+#include <babeltrace/ctf-ir/field-types.h>
+#include <babeltrace/ctf-ir/fields.h>
+#include <babeltrace/ctf-ir/packet-context-field.h>
+#include <babeltrace/ctf-ir/packet-header-field.h>
+#include <babeltrace/ctf-ir/packet.h>
+#include <babeltrace/ctf-ir/stream-class.h>
+#include <babeltrace/ctf-ir/stream.h>
+#include <babeltrace/ctf-ir/trace.h>
+#include <babeltrace/ctf-ir/utils.h>
+#include <babeltrace/ctf-ir/visitor.h>
 
-/*
- * babeltrace_iter_read_event: Read the iterator's current event data.
- *
- * @iter: trace collection iterator (input)
- * @stream: stream containing event at current position (output)
- * @event: current event (output)
- * Return 0 on success, negative error value on error.
- */
-int babeltrace_iter_read_event(struct babeltrace_iter *iter,
-               struct ctf_stream **stream,
-               struct ctf_stream_event **event);
+/* Plugin and plugin development API */
+#include <babeltrace/plugin/plugin-dev.h>
+#include <babeltrace/plugin/plugin.h>
+
+/* Graph, component, and notification API */
+#include <babeltrace/graph/clock-class-priority-map.h>
+#include <babeltrace/graph/component-class-filter.h>
+#include <babeltrace/graph/component-class-sink.h>
+#include <babeltrace/graph/component-class-source.h>
+#include <babeltrace/graph/component-class.h>
+#include <babeltrace/graph/component-filter.h>
+#include <babeltrace/graph/component-sink.h>
+#include <babeltrace/graph/component-source.h>
+#include <babeltrace/graph/component-status.h>
+#include <babeltrace/graph/component.h>
+#include <babeltrace/graph/connection.h>
+#include <babeltrace/graph/graph.h>
+#include <babeltrace/graph/notification-discarded-events.h>
+#include <babeltrace/graph/notification-discarded-packets.h>
+#include <babeltrace/graph/notification-event.h>
+#include <babeltrace/graph/notification-heap.h>
+#include <babeltrace/graph/notification-inactivity.h>
+#include <babeltrace/graph/notification-iterator.h>
+#include <babeltrace/graph/notification-packet.h>
+#include <babeltrace/graph/notification-stream.h>
+#include <babeltrace/graph/notification.h>
+#include <babeltrace/graph/output-port-notification-iterator.h>
+#include <babeltrace/graph/port.h>
+#include <babeltrace/graph/private-component-filter.h>
+#include <babeltrace/graph/private-component-sink.h>
+#include <babeltrace/graph/private-component-source.h>
+#include <babeltrace/graph/private-component.h>
+#include <babeltrace/graph/private-connection-notification-iterator.h>
+#include <babeltrace/graph/private-connection-private-notification-iterator.h>
+#include <babeltrace/graph/private-connection.h>
+#include <babeltrace/graph/private-port.h>
+#include <babeltrace/graph/query-executor.h>
 
-#endif /* _BABELTRACE_H */
+#endif /* BABELTRACE_BABELTRACE_H */
This page took 0.026847 seconds and 4 git commands to generate.