Split notification iterator API into base and specialized functions
[babeltrace.git] / bindings / python / bt2 / bt2 / native_btnotifiter.i
1 /*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25 /* Type */
26 struct bt_notification_iterator;
27
28 /* Status */
29 enum bt_notification_iterator_status {
30 BT_NOTIFICATION_ITERATOR_STATUS_CANCELED = 125,
31 BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11,
32 BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
33 BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
34 BT_NOTIFICATION_ITERATOR_STATUS_INVALID = -22,
35 BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -1,
36 BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -12,
37 BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -2,
38 };
39
40 /* Functions (base) */
41 struct bt_notification *bt_notification_iterator_get_notification(
42 struct bt_notification_iterator *iterator);
43 enum bt_notification_iterator_status bt_notification_iterator_next(
44 struct bt_notification_iterator *iterator);
45
46 /* Functions (private connection) */
47 struct bt_component *bt_private_connection_notification_iterator_get_component(
48 struct bt_notification_iterator *iterator);
49
50 /* Helper functions for Python */
51 %{
52 static PyObject *bt_py3_get_user_component_from_user_notif_iter(
53 struct bt_private_connection_private_notification_iterator *priv_notif_iter)
54 {
55 struct bt_private_component *priv_comp =
56 bt_private_connection_private_notification_iterator_get_private_component(
57 priv_notif_iter);
58 PyObject *py_comp;
59
60 assert(priv_comp);
61 py_comp = bt_private_component_get_user_data(priv_comp);
62 bt_put(priv_comp);
63 assert(py_comp);
64
65 /* Return new reference */
66 Py_INCREF(py_comp);
67 return py_comp;
68 }
69 %}
70
71 PyObject *bt_py3_get_user_component_from_user_notif_iter(
72 struct bt_private_connection_private_notification_iterator *priv_notif_iter);
This page took 0.033068 seconds and 4 git commands to generate.