Add missing permission notice in each source file

[babeltrace.git] / include / babeltrace / iterator-internal.h

diff --git a/include/babeltrace/iterator-internal.h b/include/babeltrace/iterator-internal.h
index 626a7a0009b16377406bc4e51d99425e6eda4e7e..2b0b2f23c2b5460b55ce86e9b5ad78a7c15af0a2 100644 (file)
--- a/include/babeltrace/iterator-internal.h
+++ b/include/babeltrace/iterator-internal.h
@@ -19,6 +19,14 @@
  *
  * 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.
  */
 
 #include <babeltrace/ctf/events.h>
@@ -30,13 +38,34 @@
 struct bt_iter {
        struct ptr_heap *stream_heap;
        struct bt_context *ctx;
-       struct bt_iter_pos *end_pos;
+       const struct bt_iter_pos *end_pos;
 };
 
+/*
+ * bt_iter_create - Allocate a trace collection iterator.
+ *
+ * begin_pos and end_pos are optional parameters to specify the position
+ * at which the trace collection should be seeked upon iterator
+ * creation, and the position at which iteration will start returning
+ * "EOF".
+ *
+ * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
+ * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
+ * trace) is the EOF criterion.
+ */
+struct bt_iter *bt_iter_create(struct bt_context *ctx,
+               const struct bt_iter_pos *begin_pos,
+               const struct bt_iter_pos *end_pos);
+
+/*
+ * bt_iter_destroy - Free a trace collection iterator.
+ */
+void bt_iter_destroy(struct bt_iter *iter);
+
 int bt_iter_init(struct bt_iter *iter,
                struct bt_context *ctx,
-               struct bt_iter_pos *begin_pos,
-               struct bt_iter_pos *end_pos);
+               const struct bt_iter_pos *begin_pos,
+               const struct bt_iter_pos *end_pos);
 void bt_iter_fini(struct bt_iter *iter);
 
 #endif /* _BABELTRACE_ITERATOR_INTERNAL_H */