lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / graph / message-iterator.h
1 #ifndef BABELTRACE_GRAPH_MESSAGE_ITERATOR_H
2 #define BABELTRACE_GRAPH_MESSAGE_ITERATOR_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 /* For __BT_FUNC_STATUS_* */
28 #define __BT_FUNC_STATUS_ENABLE
29 #include <babeltrace2/func-status.h>
30 #undef __BT_FUNC_STATUS_ENABLE
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 typedef enum bt_message_iterator_next_status {
37 BT_MESSAGE_ITERATOR_NEXT_STATUS_OK = __BT_FUNC_STATUS_OK,
38 BT_MESSAGE_ITERATOR_NEXT_STATUS_END = __BT_FUNC_STATUS_END,
39 BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
40 BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
41 BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
42 } bt_message_iterator_next_status;
43
44 typedef enum bt_message_iterator_seek_beginning_status {
45 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK = __BT_FUNC_STATUS_OK,
46 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_END = __BT_FUNC_STATUS_END,
47 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
48 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
49 BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
50 } bt_message_iterator_seek_beginning_status;
51
52 typedef enum bt_message_iterator_seek_ns_from_origin_status {
53 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_OK = __BT_FUNC_STATUS_OK,
54 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_END = __BT_FUNC_STATUS_END,
55 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
56 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
57 BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
58 } bt_message_iterator_seek_ns_from_origin_status;
59
60 #ifdef __cplusplus
61 }
62 #endif
63
64 #include <babeltrace2/undef-func-status.h>
65
66 #endif /* BABELTRACE_GRAPH_MESSAGE_ITERATOR_H */
This page took 0.029775 seconds and 4 git commands to generate.