plugins/ctf/common/notif-iter/notif-iter.c: add logging
[babeltrace.git] / include / babeltrace / graph / notification-heap.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_NOTIFICATION_HEAP_H
2#define BABELTRACE_GRAPH_NOTIFICATION_HEAP_H
7c6ea146
JG
3
4/*
6a5c560c 5 * Babeltrace - Notification Heap
7c6ea146
JG
6 *
7 * Copyright (c) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * Copyright (c) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * SOFTWARE.
27 */
28
29#include <stddef.h>
b2e0c907 30#include <babeltrace/graph/notification.h>
7c6ea146 31#include <babeltrace/babeltrace-internal.h>
c55a9f58 32#include <babeltrace/types.h>
7c6ea146
JG
33
34/**
35 * bt_notification_time_compare - Compare two notifications' timestamps
36 *
37 * Compare two notifications in the time domain. Return true if 'a' happened
38 * prior to 'b'. In the case where both notifications are deemed to have
39 * happened at the same time, an implementation-defined critarion shall be
40 * used to order the notifications. This criterion shall ensure a consistent
41 * ordering over multiple runs.
42 */
c55a9f58 43typedef bt_bool (*bt_notification_time_compare_func)(
352fe16f
JG
44 struct bt_notification *a, struct bt_notification *b,
45 void *user_data);
7c6ea146
JG
46
47/**
48 * bt_notification_heap_create - create a new bt_notification heap.
49 *
50 * @comparator: Function to use for notification comparisons.
51 *
52 * Returns a new notification heap, NULL on error.
53 */
54extern struct bt_notification_heap *bt_notification_heap_create(
352fe16f 55 bt_notification_time_compare_func comparator, void *user_data);
7c6ea146
JG
56
57/**
58 * bt_notification_heap_insert - insert an element into the heap
59 *
60 * @heap: the heap to be operated on
61 * @notification: the notification to add
62 *
63 * Insert a notification into the heap.
64 *
65 * Returns 0 on success, a negative value on error.
66 */
67extern int bt_notification_heap_insert(struct bt_notification_heap *heap,
68 struct bt_notification *notification);
69
70/**
71 * bt_notification_heap_peek - return the element on top of the heap.
72 *
73 * @heap: the heap to be operated on
74 *
75 * Returns the top element of the heap, without performing any modification
76 * to the heap structure. Returns NULL if the heap is empty. The returned
77 * notification must be bt_put() by the caller.
78 */
79extern struct bt_notification *bt_notification_heap_peek(
80 struct bt_notification_heap *heap);
81
82/**
83 * bt_notification_heap_pop - remove the element sitting on top of the heap.
84 * @heap: the heap to be operated on
85 *
86 * Returns the top element of the heap. The element is removed from the
87 * heap. Returns NULL if the heap is empty. The returned notification must be
88 * bt_put() by the caller.
89 */
6a5c560c
JG
90extern struct bt_notification *bt_notification_heap_pop(
91 struct bt_notification_heap *heap);
7c6ea146 92
1ca80abd 93#endif /* BABELTRACE_GRAPH_NOTIFICATION_HEAP_H */
This page took 0.035507 seconds and 4 git commands to generate.