1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining a copy
6 # of this software and associated documentation files (the "Software"), to deal
7 # in the Software without restriction, including without limitation the rights
8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 # copies of the Software, and to permit persons to whom the Software is
10 # furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 from bt2
import native_bt
, object, utils
25 import collections
.abc
30 class _MessageIterator(collections
.abc
.Iterator
):
31 def _handle_status(self
, status
, gen_error_msg
):
32 if status
== native_bt
.MESSAGE_ITERATOR_STATUS_CANCELED
:
33 raise bt2
.MessageIteratorCanceled
34 elif status
== native_bt
.MESSAGE_ITERATOR_STATUS_AGAIN
:
36 elif status
== native_bt
.MESSAGE_ITERATOR_STATUS_END
:
38 elif status
== native_bt
.MESSAGE_ITERATOR_STATUS_UNSUPPORTED
:
39 raise bt2
.UnsupportedFeature
41 raise bt2
.Error(gen_error_msg
)
44 raise NotImplementedError
47 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
49 msg_ptr
= native_bt
.message_iterator_get_message(self
._ptr
)
50 utils
._handle
_ptr
(msg_ptr
, "cannot get message iterator object's current message object")
51 return bt2
.message
._create
_from
_ptr
(msg_ptr
)
54 status
= native_bt
.message_iterator_next(self
._ptr
)
55 self
._handle
_status
(status
,
56 'unexpected error: cannot advance the message iterator')
60 return self
._get
_msg
()
63 class _PrivateConnectionMessageIterator(_GenericMessageIterator
):
66 comp_ptr
= native_bt
.private_connection_message_iterator_get_component(self
._ptr
)
68 return bt2
.component
._create
_generic
_component
_from
_ptr
(comp_ptr
)
71 class _OutputPortMessageIterator(_GenericMessageIterator
):
75 class _UserMessageIterator(_MessageIterator
):
76 def __new__(cls
, ptr
):
77 # User iterator objects are always created by the native side,
78 # that is, never instantiated directly by Python code.
80 # The native code calls this, then manually calls
81 # self.__init__() without the `ptr` argument. The user has
82 # access to self.component during this call, thanks to this
83 # self._ptr argument being set.
85 # self._ptr is NOT owned by this object here, so there's nothing
87 self
= super().__new
__(cls
)
96 return native_bt
.py3_get_user_component_from_user_msg_iter(self
._ptr
)
100 return int(self
._ptr
)
108 def _next_from_native(self
):
109 # this can raise anything: it's catched by the native part
112 except StopIteration:
117 utils
._check
_type
(msg
, bt2
.message
._Message
)
119 # take a new reference for the native part