Commit | Line | Data |
---|---|---|
0235b0db | 1 | # SPDX-License-Identifier: MIT |
81447b5b PP |
2 | # |
3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> | |
81447b5b PP |
4 | |
5 | from bt2 import native_bt, object, utils | |
3fb99a22 | 6 | from bt2 import message_iterator as bt2_message_iterator |
81447b5b | 7 | import collections.abc |
3fb99a22 PP |
8 | from bt2 import value as bt2_value |
9 | from bt2 import trace_class as bt2_trace_class | |
10 | from bt2 import clock_class as bt2_clock_class | |
11 | from bt2 import query_executor as bt2_query_executor | |
3fb99a22 | 12 | from bt2 import port as bt2_port |
40910fbb | 13 | import sys |
81447b5b | 14 | import bt2 |
811644b8 PP |
15 | |
16 | ||
81447b5b PP |
17 | # This class wraps a component class pointer. This component class could |
18 | # have been created by Python code, but since we only have the pointer, | |
19 | # we can only wrap it in a generic way and lose the original Python | |
20 | # class. | |
601c0026 SM |
21 | # |
22 | # Subclasses must implement some methods that this base class uses: | |
23 | # | |
85906b6b | 24 | # - _bt_as_component_class_ptr: static method, convert the passed component class |
601c0026 SM |
25 | # pointer to a 'bt_component_class *'. |
26 | ||
cfbd7cf3 | 27 | |
615238be | 28 | class _ComponentClassConst(object._SharedObject): |
81447b5b PP |
29 | @property |
30 | def name(self): | |
85906b6b | 31 | ptr = self._bt_as_component_class_ptr(self._ptr) |
601c0026 SM |
32 | name = native_bt.component_class_get_name(ptr) |
33 | assert name is not None | |
811644b8 | 34 | return name |
81447b5b PP |
35 | |
36 | @property | |
37 | def description(self): | |
85906b6b | 38 | ptr = self._bt_as_component_class_ptr(self._ptr) |
601c0026 | 39 | return native_bt.component_class_get_description(ptr) |
81447b5b | 40 | |
40910fbb PP |
41 | @property |
42 | def help(self): | |
85906b6b | 43 | ptr = self._bt_as_component_class_ptr(self._ptr) |
601c0026 SM |
44 | return native_bt.component_class_get_help(ptr) |
45 | ||
85906b6b FD |
46 | def _bt_component_class_ptr(self): |
47 | return self._bt_as_component_class_ptr(self._ptr) | |
40910fbb | 48 | |
811644b8 | 49 | def __eq__(self, other): |
615238be | 50 | if not isinstance(other, _ComponentClassConst): |
811644b8 PP |
51 | try: |
52 | if not issubclass(other, _UserComponent): | |
53 | return False | |
54 | except TypeError: | |
55 | return False | |
81447b5b | 56 | |
811644b8 | 57 | return self.addr == other.addr |
81447b5b PP |
58 | |
59 | ||
615238be | 60 | class _SourceComponentClassConst(_ComponentClassConst): |
2f16a6a2 PP |
61 | _get_ref = staticmethod(native_bt.component_class_source_get_ref) |
62 | _put_ref = staticmethod(native_bt.component_class_source_put_ref) | |
cfbd7cf3 FD |
63 | _bt_as_component_class_ptr = staticmethod( |
64 | native_bt.component_class_source_as_component_class | |
65 | ) | |
81447b5b PP |
66 | |
67 | ||
615238be | 68 | class _FilterComponentClassConst(_ComponentClassConst): |
2f16a6a2 PP |
69 | _get_ref = staticmethod(native_bt.component_class_filter_get_ref) |
70 | _put_ref = staticmethod(native_bt.component_class_filter_put_ref) | |
cfbd7cf3 FD |
71 | _bt_as_component_class_ptr = staticmethod( |
72 | native_bt.component_class_filter_as_component_class | |
73 | ) | |
81447b5b PP |
74 | |
75 | ||
615238be | 76 | class _SinkComponentClassConst(_ComponentClassConst): |
2f16a6a2 PP |
77 | _get_ref = staticmethod(native_bt.component_class_sink_get_ref) |
78 | _put_ref = staticmethod(native_bt.component_class_sink_put_ref) | |
cfbd7cf3 FD |
79 | _bt_as_component_class_ptr = staticmethod( |
80 | native_bt.component_class_sink_as_component_class | |
81 | ) | |
81447b5b PP |
82 | |
83 | ||
811644b8 PP |
84 | class _PortIterator(collections.abc.Iterator): |
85 | def __init__(self, comp_ports): | |
86 | self._comp_ports = comp_ports | |
87 | self._at = 0 | |
88 | ||
89 | def __next__(self): | |
90 | if self._at == len(self._comp_ports): | |
91 | raise StopIteration | |
92 | ||
93 | comp_ports = self._comp_ports | |
894a8df5 SM |
94 | comp_ptr = comp_ports._component_ptr |
95 | ||
96 | port_ptr = comp_ports._borrow_port_ptr_at_index(comp_ptr, self._at) | |
97 | assert port_ptr is not None | |
98 | ||
99 | name = native_bt.port_get_name(comp_ports._port_pycls._as_port_ptr(port_ptr)) | |
100 | assert name is not None | |
811644b8 | 101 | |
811644b8 PP |
102 | self._at += 1 |
103 | return name | |
104 | ||
105 | ||
106 | class _ComponentPorts(collections.abc.Mapping): | |
894a8df5 SM |
107 | |
108 | # component_ptr is a bt_component_source *, bt_component_filter * or | |
109 | # bt_component_sink *. Its type must match the type expected by the | |
110 | # functions passed as arguments. | |
111 | ||
cfbd7cf3 FD |
112 | def __init__( |
113 | self, | |
114 | component_ptr, | |
115 | borrow_port_ptr_by_name, | |
116 | borrow_port_ptr_at_index, | |
117 | get_port_count, | |
118 | port_pycls, | |
119 | ): | |
894a8df5 SM |
120 | self._component_ptr = component_ptr |
121 | self._borrow_port_ptr_by_name = borrow_port_ptr_by_name | |
122 | self._borrow_port_ptr_at_index = borrow_port_ptr_at_index | |
123 | self._get_port_count = get_port_count | |
124 | self._port_pycls = port_pycls | |
811644b8 PP |
125 | |
126 | def __getitem__(self, key): | |
127 | utils._check_str(key) | |
894a8df5 | 128 | port_ptr = self._borrow_port_ptr_by_name(self._component_ptr, key) |
811644b8 PP |
129 | |
130 | if port_ptr is None: | |
131 | raise KeyError(key) | |
132 | ||
894a8df5 | 133 | return self._port_pycls._create_from_ptr_and_get_ref(port_ptr) |
811644b8 PP |
134 | |
135 | def __len__(self): | |
894a8df5 SM |
136 | count = self._get_port_count(self._component_ptr) |
137 | assert count >= 0 | |
811644b8 PP |
138 | return count |
139 | ||
140 | def __iter__(self): | |
141 | return _PortIterator(self) | |
142 | ||
143 | ||
81447b5b | 144 | # This class holds the methods which are common to both generic |
601c0026 SM |
145 | # component objects and Python user component objects. |
146 | # | |
147 | # Subclasses must provide these methods or property: | |
148 | # | |
85906b6b | 149 | # - _bt_borrow_component_class_ptr: static method, must return a pointer to the |
601c0026 SM |
150 | # specialized component class (e.g. 'bt_component_class_sink *') of the |
151 | # passed specialized component pointer (e.g. 'bt_component_sink *'). | |
85906b6b | 152 | # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* |
601c0026 | 153 | # constants. |
85906b6b | 154 | # - _bt_as_component_ptr: static method, must return the passed specialized |
1c9ed2ff | 155 | # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'. |
601c0026 | 156 | |
cfbd7cf3 | 157 | |
615238be | 158 | class _ComponentConst: |
81447b5b PP |
159 | @property |
160 | def name(self): | |
85906b6b | 161 | ptr = self._bt_as_component_ptr(self._ptr) |
1c9ed2ff SM |
162 | name = native_bt.component_get_name(ptr) |
163 | assert name is not None | |
811644b8 PP |
164 | return name |
165 | ||
e874da19 PP |
166 | @property |
167 | def logging_level(self): | |
85906b6b | 168 | ptr = self._bt_as_component_ptr(self._ptr) |
e874da19 PP |
169 | return native_bt.component_get_logging_level(ptr) |
170 | ||
81447b5b | 171 | @property |
e8ac1aae | 172 | def cls(self): |
85906b6b | 173 | cc_ptr = self._bt_borrow_component_class_ptr(self._ptr) |
601c0026 | 174 | assert cc_ptr is not None |
615238be | 175 | return _create_component_class_from_const_ptr_and_get_ref( |
cfbd7cf3 FD |
176 | cc_ptr, self._bt_comp_cls_type |
177 | ) | |
81447b5b | 178 | |
811644b8 PP |
179 | def __eq__(self, other): |
180 | if not hasattr(other, 'addr'): | |
181 | return False | |
81447b5b | 182 | |
811644b8 | 183 | return self.addr == other.addr |
81447b5b | 184 | |
81447b5b | 185 | |
615238be | 186 | class _SourceComponentConst(_ComponentConst): |
cfbd7cf3 FD |
187 | _bt_borrow_component_class_ptr = staticmethod( |
188 | native_bt.component_source_borrow_class_const | |
189 | ) | |
85906b6b | 190 | _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE |
cfbd7cf3 FD |
191 | _bt_as_component_class_ptr = staticmethod( |
192 | native_bt.component_class_source_as_component_class | |
193 | ) | |
85906b6b | 194 | _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const) |
81447b5b | 195 | |
81447b5b | 196 | |
615238be | 197 | class _FilterComponentConst(_ComponentConst): |
cfbd7cf3 FD |
198 | _bt_borrow_component_class_ptr = staticmethod( |
199 | native_bt.component_filter_borrow_class_const | |
200 | ) | |
85906b6b | 201 | _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER |
cfbd7cf3 FD |
202 | _bt_as_component_class_ptr = staticmethod( |
203 | native_bt.component_class_filter_as_component_class | |
204 | ) | |
85906b6b | 205 | _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const) |
81447b5b | 206 | |
81447b5b | 207 | |
615238be | 208 | class _SinkComponentConst(_ComponentConst): |
cfbd7cf3 FD |
209 | _bt_borrow_component_class_ptr = staticmethod( |
210 | native_bt.component_sink_borrow_class_const | |
211 | ) | |
85906b6b | 212 | _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK |
cfbd7cf3 FD |
213 | _bt_as_component_class_ptr = staticmethod( |
214 | native_bt.component_class_sink_as_component_class | |
215 | ) | |
85906b6b | 216 | _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const) |
81447b5b PP |
217 | |
218 | ||
615238be | 219 | # This is analogous to _SourceComponentClassConst, but for source |
81447b5b | 220 | # component objects. |
615238be | 221 | class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst): |
894a8df5 SM |
222 | _get_ref = staticmethod(native_bt.component_source_get_ref) |
223 | _put_ref = staticmethod(native_bt.component_source_put_ref) | |
224 | ||
811644b8 PP |
225 | @property |
226 | def output_ports(self): | |
cfbd7cf3 FD |
227 | return _ComponentPorts( |
228 | self._ptr, | |
229 | native_bt.component_source_borrow_output_port_by_name_const, | |
230 | native_bt.component_source_borrow_output_port_by_index_const, | |
231 | native_bt.component_source_get_output_port_count, | |
5813b3a3 | 232 | bt2_port._OutputPortConst, |
cfbd7cf3 | 233 | ) |
81447b5b PP |
234 | |
235 | ||
615238be | 236 | # This is analogous to _FilterComponentClassConst, but for filter |
81447b5b | 237 | # component objects. |
615238be | 238 | class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst): |
894a8df5 SM |
239 | _get_ref = staticmethod(native_bt.component_filter_get_ref) |
240 | _put_ref = staticmethod(native_bt.component_filter_put_ref) | |
241 | ||
811644b8 PP |
242 | @property |
243 | def output_ports(self): | |
cfbd7cf3 FD |
244 | return _ComponentPorts( |
245 | self._ptr, | |
246 | native_bt.component_filter_borrow_output_port_by_name_const, | |
247 | native_bt.component_filter_borrow_output_port_by_index_const, | |
248 | native_bt.component_filter_get_output_port_count, | |
5813b3a3 | 249 | bt2_port._OutputPortConst, |
cfbd7cf3 | 250 | ) |
811644b8 PP |
251 | |
252 | @property | |
253 | def input_ports(self): | |
cfbd7cf3 FD |
254 | return _ComponentPorts( |
255 | self._ptr, | |
256 | native_bt.component_filter_borrow_input_port_by_name_const, | |
257 | native_bt.component_filter_borrow_input_port_by_index_const, | |
258 | native_bt.component_filter_get_input_port_count, | |
5813b3a3 | 259 | bt2_port._InputPortConst, |
cfbd7cf3 | 260 | ) |
81447b5b PP |
261 | |
262 | ||
615238be | 263 | # This is analogous to _SinkComponentClassConst, but for sink |
81447b5b | 264 | # component objects. |
615238be | 265 | class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst): |
2f16a6a2 PP |
266 | _get_ref = staticmethod(native_bt.component_sink_get_ref) |
267 | _put_ref = staticmethod(native_bt.component_sink_put_ref) | |
601c0026 | 268 | |
811644b8 PP |
269 | @property |
270 | def input_ports(self): | |
cfbd7cf3 FD |
271 | return _ComponentPorts( |
272 | self._ptr, | |
273 | native_bt.component_sink_borrow_input_port_by_name_const, | |
274 | native_bt.component_sink_borrow_input_port_by_index_const, | |
275 | native_bt.component_sink_get_input_port_count, | |
5813b3a3 | 276 | bt2_port._InputPortConst, |
cfbd7cf3 | 277 | ) |
81447b5b PP |
278 | |
279 | ||
811644b8 | 280 | _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = { |
615238be FD |
281 | native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentConst, |
282 | native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentConst, | |
283 | native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentConst, | |
81447b5b PP |
284 | } |
285 | ||
286 | ||
811644b8 | 287 | _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = { |
615238be FD |
288 | native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClassConst, |
289 | native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClassConst, | |
290 | native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClassConst, | |
81447b5b PP |
291 | } |
292 | ||
293 | ||
615238be FD |
294 | # Create a component Python object of type _GenericSourceComponentConst, |
295 | # _GenericFilterComponentConst or _GenericSinkComponentConst, depending on | |
601c0026 SM |
296 | # comp_cls_type. |
297 | # | |
298 | # Steals the reference to ptr from the caller. | |
299 | ||
cfbd7cf3 | 300 | |
615238be | 301 | def _create_component_from_const_ptr(ptr, comp_cls_type): |
811644b8 | 302 | return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr) |
81447b5b | 303 | |
5f25509b SM |
304 | |
305 | # Same as the above, but acquire a new reference instead of stealing the | |
306 | # reference from the caller. | |
307 | ||
cfbd7cf3 | 308 | |
615238be | 309 | def _create_component_from_const_ptr_and_get_ref(ptr, comp_cls_type): |
cfbd7cf3 FD |
310 | return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[ |
311 | comp_cls_type | |
312 | ]._create_from_ptr_and_get_ref(ptr) | |
5f25509b SM |
313 | |
314 | ||
601c0026 | 315 | # Create a component class Python object of type |
615238be FD |
316 | # _SourceComponentClassConst, _FilterComponentClassConst or |
317 | # _SinkComponentClassConst, depending on comp_cls_type. | |
601c0026 SM |
318 | # |
319 | # Acquires a new reference to ptr. | |
81447b5b | 320 | |
cfbd7cf3 | 321 | |
615238be | 322 | def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type): |
cfbd7cf3 FD |
323 | return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[ |
324 | comp_cls_type | |
325 | ]._create_from_ptr_and_get_ref(ptr) | |
81447b5b PP |
326 | |
327 | ||
40910fbb PP |
328 | def _trim_docstring(docstring): |
329 | lines = docstring.expandtabs().splitlines() | |
330 | indent = sys.maxsize | |
331 | ||
332 | for line in lines[1:]: | |
333 | stripped = line.lstrip() | |
334 | ||
335 | if stripped: | |
336 | indent = min(indent, len(line) - len(stripped)) | |
337 | ||
338 | trimmed = [lines[0].strip()] | |
339 | ||
340 | if indent < sys.maxsize: | |
341 | for line in lines[1:]: | |
342 | trimmed.append(line[indent:].rstrip()) | |
343 | ||
344 | while trimmed and not trimmed[-1]: | |
345 | trimmed.pop() | |
346 | ||
347 | while trimmed and not trimmed[0]: | |
348 | trimmed.pop(0) | |
349 | ||
350 | return '\n'.join(trimmed) | |
351 | ||
352 | ||
81447b5b PP |
353 | # Metaclass for component classes defined by Python code. |
354 | # | |
355 | # The Python user can create a standard Python class which inherits one | |
811644b8 PP |
356 | # of the three base classes (_UserSourceComponent, _UserFilterComponent, |
357 | # or _UserSinkComponent). Those base classes set this class | |
81447b5b PP |
358 | # (_UserComponentType) as their metaclass. |
359 | # | |
360 | # Once the body of a user-defined component class is executed, this | |
361 | # metaclass is used to create and initialize the class. The metaclass | |
362 | # creates a native BT component class of the corresponding type and | |
363 | # associates it with this user-defined class. The metaclass also defines | |
364 | # class methods like the `name` and `description` properties to match | |
615238be | 365 | # the _ComponentClassConst interface. |
81447b5b PP |
366 | # |
367 | # The component class name which is used is either: | |
368 | # | |
369 | # * The `name` parameter of the class: | |
370 | # | |
371 | # class MySink(bt2.SinkComponent, name='my-custom-sink'): | |
372 | # ... | |
373 | # | |
374 | # * If the `name` class parameter is not used: the name of the class | |
375 | # itself (`MySink` in the example above). | |
376 | # | |
377 | # The component class description which is used is the user-defined | |
378 | # class's docstring: | |
379 | # | |
380 | # class MySink(bt2.SinkComponent): | |
381 | # 'Description goes here' | |
382 | # ... | |
383 | # | |
384 | # A user-defined Python component class can have an __init__() method | |
385 | # which must at least accept the `params` and `name` arguments: | |
386 | # | |
387 | # def __init__(self, params, name, something_else): | |
388 | # ... | |
389 | # | |
811644b8 | 390 | # The user-defined component class can also have a _finalize() method |
81447b5b | 391 | # (do NOT use __del__()) to be notified when the component object is |
811644b8 | 392 | # finalized. |
81447b5b PP |
393 | # |
394 | # User-defined source and filter component classes must use the | |
5602ef81 SM |
395 | # `message_iterator_class` class parameter to specify the |
396 | # message iterator class to use for this component class: | |
81447b5b | 397 | # |
5602ef81 | 398 | # class MyMessageIterator(bt2._UserMessageIterator): |
81447b5b PP |
399 | # ... |
400 | # | |
811644b8 | 401 | # class MySource(bt2._UserSourceComponent, |
5602ef81 | 402 | # message_iterator_class=MyMessageIterator): |
81447b5b PP |
403 | # ... |
404 | # | |
5602ef81 SM |
405 | # This message iterator class must inherit |
406 | # bt2._UserMessageIterator, and it must define the _get() and | |
407 | # _next() methods. The message iterator class can also define an | |
81447b5b PP |
408 | # __init__() method: this method has access to the original Python |
409 | # component object which was used to create it as the `component` | |
5602ef81 | 410 | # property. The message iterator class can also define a |
811644b8 | 411 | # _finalize() method (again, do NOT use __del__()): this is called when |
5602ef81 | 412 | # the message iterator is (really) destroyed. |
81447b5b PP |
413 | # |
414 | # When the user-defined class is destroyed, this metaclass's __del__() | |
415 | # method is called: the native BT component class pointer is put (not | |
416 | # needed anymore, at least not by any Python code since all references | |
417 | # are dropped for __del__() to be called). | |
418 | class _UserComponentType(type): | |
419 | # __new__() is used to catch custom class parameters | |
420 | def __new__(meta_cls, class_name, bases, attrs, **kwargs): | |
421 | return super().__new__(meta_cls, class_name, bases, attrs) | |
422 | ||
423 | def __init__(cls, class_name, bases, namespace, **kwargs): | |
424 | super().__init__(class_name, bases, namespace) | |
425 | ||
426 | # skip our own bases; they are never directly instantiated by the user | |
811644b8 PP |
427 | own_bases = ( |
428 | '_UserComponent', | |
429 | '_UserFilterSinkComponent', | |
430 | '_UserSourceComponent', | |
431 | '_UserFilterComponent', | |
432 | '_UserSinkComponent', | |
433 | ) | |
434 | ||
435 | if class_name in own_bases: | |
81447b5b PP |
436 | return |
437 | ||
438 | comp_cls_name = kwargs.get('name', class_name) | |
811644b8 | 439 | utils._check_str(comp_cls_name) |
40910fbb PP |
440 | comp_cls_descr = None |
441 | comp_cls_help = None | |
442 | ||
443 | if hasattr(cls, '__doc__') and cls.__doc__ is not None: | |
811644b8 | 444 | utils._check_str(cls.__doc__) |
40910fbb PP |
445 | docstring = _trim_docstring(cls.__doc__) |
446 | lines = docstring.splitlines() | |
447 | ||
448 | if len(lines) >= 1: | |
449 | comp_cls_descr = lines[0] | |
450 | ||
451 | if len(lines) >= 3: | |
452 | comp_cls_help = '\n'.join(lines[2:]) | |
453 | ||
5602ef81 | 454 | iter_cls = kwargs.get('message_iterator_class') |
81447b5b | 455 | |
811644b8 | 456 | if _UserSourceComponent in bases: |
85906b6b | 457 | _UserComponentType._bt_set_iterator_class(cls, iter_cls) |
cfbd7cf3 FD |
458 | cc_ptr = native_bt.bt2_component_class_source_create( |
459 | cls, comp_cls_name, comp_cls_descr, comp_cls_help | |
460 | ) | |
811644b8 | 461 | elif _UserFilterComponent in bases: |
85906b6b | 462 | _UserComponentType._bt_set_iterator_class(cls, iter_cls) |
cfbd7cf3 FD |
463 | cc_ptr = native_bt.bt2_component_class_filter_create( |
464 | cls, comp_cls_name, comp_cls_descr, comp_cls_help | |
465 | ) | |
811644b8 | 466 | elif _UserSinkComponent in bases: |
6a91742b | 467 | if not hasattr(cls, '_user_consume'): |
cb06aa27 | 468 | raise bt2._IncompleteUserClass( |
6a91742b | 469 | "cannot create component class '{}': missing a _user_consume() method".format( |
cfbd7cf3 FD |
470 | class_name |
471 | ) | |
472 | ) | |
473 | ||
474 | cc_ptr = native_bt.bt2_component_class_sink_create( | |
475 | cls, comp_cls_name, comp_cls_descr, comp_cls_help | |
476 | ) | |
81447b5b | 477 | else: |
cb06aa27 | 478 | raise bt2._IncompleteUserClass( |
cfbd7cf3 FD |
479 | "cannot find a known component class base in the bases of '{}'".format( |
480 | class_name | |
481 | ) | |
482 | ) | |
81447b5b PP |
483 | |
484 | if cc_ptr is None: | |
694c792b | 485 | raise bt2._MemoryError( |
cfbd7cf3 FD |
486 | "cannot create component class '{}'".format(class_name) |
487 | ) | |
81447b5b | 488 | |
85906b6b | 489 | cls._bt_cc_ptr = cc_ptr |
81447b5b | 490 | |
66964f3f | 491 | def _bt_init_from_native(cls, comp_ptr, params_ptr, obj): |
811644b8 | 492 | # create instance, not user-initialized yet |
81447b5b PP |
493 | self = cls.__new__(cls) |
494 | ||
59225a3e SM |
495 | # config object |
496 | config = cls._config_pycls() | |
497 | ||
601c0026 | 498 | # pointer to native self component object (weak/borrowed) |
85906b6b | 499 | self._bt_ptr = comp_ptr |
81447b5b | 500 | |
811644b8 PP |
501 | # call user's __init__() method |
502 | if params_ptr is not None: | |
e42e1587 | 503 | params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) |
811644b8 PP |
504 | else: |
505 | params = None | |
81447b5b | 506 | |
59225a3e | 507 | self.__init__(config, params, obj) |
81447b5b PP |
508 | return self |
509 | ||
811644b8 | 510 | def __call__(cls, *args, **kwargs): |
ce4923b0 | 511 | raise RuntimeError( |
cfbd7cf3 FD |
512 | 'cannot directly instantiate a user component from a Python module' |
513 | ) | |
81447b5b PP |
514 | |
515 | @staticmethod | |
85906b6b | 516 | def _bt_set_iterator_class(cls, iter_cls): |
81447b5b | 517 | if iter_cls is None: |
cb06aa27 | 518 | raise bt2._IncompleteUserClass( |
cfbd7cf3 FD |
519 | "cannot create component class '{}': missing message iterator class".format( |
520 | cls.__name__ | |
521 | ) | |
522 | ) | |
81447b5b | 523 | |
3fb99a22 | 524 | if not issubclass(iter_cls, bt2_message_iterator._UserMessageIterator): |
cb06aa27 | 525 | raise bt2._IncompleteUserClass( |
cfbd7cf3 FD |
526 | "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format( |
527 | cls.__name__ | |
528 | ) | |
529 | ) | |
81447b5b | 530 | |
811644b8 | 531 | if not hasattr(iter_cls, '__next__'): |
cb06aa27 | 532 | raise bt2._IncompleteUserClass( |
cfbd7cf3 FD |
533 | "cannot create component class '{}': message iterator class is missing a __next__() method".format( |
534 | cls.__name__ | |
535 | ) | |
536 | ) | |
81447b5b | 537 | |
2e1b5615 SM |
538 | if hasattr(iter_cls, '_user_can_seek_ns_from_origin') and not hasattr( |
539 | iter_cls, '_user_seek_ns_from_origin' | |
540 | ): | |
541 | raise bt2._IncompleteUserClass( | |
542 | "cannot create component class '{}': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin".format( | |
543 | cls.__name__ | |
544 | ) | |
545 | ) | |
546 | ||
547 | if hasattr(iter_cls, '_user_can_seek_beginning') and not hasattr( | |
548 | iter_cls, '_user_seek_beginning' | |
549 | ): | |
550 | raise bt2._IncompleteUserClass( | |
551 | "cannot create component class '{}': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning".format( | |
552 | cls.__name__ | |
553 | ) | |
554 | ) | |
555 | ||
81447b5b PP |
556 | cls._iter_cls = iter_cls |
557 | ||
558 | @property | |
559 | def name(cls): | |
85906b6b | 560 | ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) |
601c0026 | 561 | return native_bt.component_class_get_name(ptr) |
81447b5b PP |
562 | |
563 | @property | |
564 | def description(cls): | |
85906b6b | 565 | ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) |
601c0026 | 566 | return native_bt.component_class_get_description(ptr) |
81447b5b | 567 | |
40910fbb PP |
568 | @property |
569 | def help(cls): | |
85906b6b | 570 | ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) |
601c0026 | 571 | return native_bt.component_class_get_help(ptr) |
40910fbb | 572 | |
81447b5b PP |
573 | @property |
574 | def addr(cls): | |
85906b6b | 575 | return int(cls._bt_cc_ptr) |
81447b5b | 576 | |
fd57054b PP |
577 | def _bt_get_supported_mip_versions_from_native(cls, params_ptr, obj, log_level): |
578 | # this can raise, but the native side checks the exception | |
579 | if params_ptr is not None: | |
e42e1587 | 580 | params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) |
fd57054b PP |
581 | else: |
582 | params = None | |
583 | ||
584 | # this can raise, but the native side checks the exception | |
585 | range_set = cls._user_get_supported_mip_versions(params, obj, log_level) | |
586 | ||
587 | if type(range_set) is not bt2.UnsignedIntegerRangeSet: | |
588 | # this can raise, but the native side checks the exception | |
589 | range_set = bt2.UnsignedIntegerRangeSet(range_set) | |
590 | ||
591 | # return new reference | |
592 | range_set._get_ref(range_set._ptr) | |
593 | return int(range_set._ptr) | |
594 | ||
595 | def _user_get_supported_mip_versions(cls, params, obj, log_level): | |
596 | return [0] | |
597 | ||
0b9ddc00 PP |
598 | def _bt_query_from_native( |
599 | cls, priv_query_exec_ptr, object_name, params_ptr, method_obj | |
600 | ): | |
fd57054b | 601 | # this can raise, but the native side checks the exception |
811644b8 | 602 | if params_ptr is not None: |
e42e1587 | 603 | params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) |
811644b8 PP |
604 | else: |
605 | params = None | |
606 | ||
3c729b9a | 607 | priv_query_exec = bt2_query_executor._PrivateQueryExecutor(priv_query_exec_ptr) |
811644b8 | 608 | |
3c729b9a PP |
609 | try: |
610 | # this can raise, but the native side checks the exception | |
0b9ddc00 | 611 | results = cls._user_query(priv_query_exec, object_name, params, method_obj) |
3c729b9a PP |
612 | finally: |
613 | # the private query executor is a private view on the query | |
614 | # executor; it's not a shared object (the library does not | |
615 | # offer an API to get/put a reference, just like "self" | |
616 | # objects) from this query's point of view, so invalidate | |
617 | # the object in case the user kept a reference and uses it | |
618 | # later | |
619 | priv_query_exec._invalidate() | |
811644b8 | 620 | |
c7eee084 PP |
621 | # this can raise, but the native side checks the exception |
622 | results = bt2.create_value(results) | |
911dec08 PP |
623 | |
624 | if results is None: | |
b5947615 | 625 | results_ptr = native_bt.value_null |
911dec08 | 626 | else: |
b5947615 | 627 | results_ptr = results._ptr |
911dec08 | 628 | |
3c729b9a | 629 | # return new reference |
3fb99a22 | 630 | bt2_value._Value._get_ref(results_ptr) |
b5947615 | 631 | return int(results_ptr) |
911dec08 | 632 | |
0b9ddc00 | 633 | def _user_query(cls, priv_query_executor, object_name, params, method_obj): |
76b6c2f7 | 634 | raise bt2.UnknownObject |
811644b8 | 635 | |
85906b6b FD |
636 | def _bt_component_class_ptr(self): |
637 | return self._bt_as_component_class_ptr(self._bt_cc_ptr) | |
911dec08 | 638 | |
81447b5b | 639 | def __del__(cls): |
85906b6b FD |
640 | if hasattr(cls, '_bt_cc_ptr'): |
641 | cc_ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) | |
601c0026 | 642 | native_bt.component_class_put_ref(cc_ptr) |
ab1cea3f | 643 | native_bt.bt2_unregister_cc_ptr_to_py_cls(cc_ptr) |
81447b5b | 644 | |
cfbd7cf3 | 645 | |
59225a3e SM |
646 | # Configuration objects for components. |
647 | # | |
648 | # These are passed in __init__ to allow components to change some configuration | |
649 | # parameters during initialization and not after. As you can see, they are not | |
650 | # used at the moment, but are there in case we want to add such parameters. | |
651 | ||
652 | ||
653 | class _UserComponentConfiguration: | |
654 | pass | |
655 | ||
656 | ||
657 | class _UserSourceComponentConfiguration(_UserComponentConfiguration): | |
658 | pass | |
659 | ||
660 | ||
661 | class _UserFilterComponentConfiguration(_UserComponentConfiguration): | |
662 | pass | |
663 | ||
664 | ||
665 | class _UserSinkComponentConfiguration(_UserComponentConfiguration): | |
666 | pass | |
667 | ||
668 | ||
1c9ed2ff SM |
669 | # Subclasses must provide these methods or property: |
670 | # | |
85906b6b | 671 | # - _bt_as_not_self_specific_component_ptr: static method, must return the passed |
1c9ed2ff SM |
672 | # specialized self component pointer (e.g. 'bt_self_component_sink *') as a |
673 | # specialized non-self pointer (e.g. 'bt_component_sink *'). | |
85906b6b | 674 | # - _bt_borrow_component_class_ptr: static method, must return a pointer to the |
1c9ed2ff SM |
675 | # specialized component class (e.g. 'bt_component_class_sink *') of the |
676 | # passed specialized component pointer (e.g. 'bt_component_sink *'). | |
85906b6b | 677 | # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_* |
1c9ed2ff | 678 | # constants. |
81447b5b | 679 | |
cfbd7cf3 | 680 | |
811644b8 PP |
681 | class _UserComponent(metaclass=_UserComponentType): |
682 | @property | |
683 | def name(self): | |
85906b6b FD |
684 | ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) |
685 | ptr = self._bt_as_component_ptr(ptr) | |
1c9ed2ff SM |
686 | name = native_bt.component_get_name(ptr) |
687 | assert name is not None | |
811644b8 | 688 | return name |
81447b5b | 689 | |
e874da19 PP |
690 | @property |
691 | def logging_level(self): | |
85906b6b FD |
692 | ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) |
693 | ptr = self._bt_as_component_ptr(ptr) | |
e874da19 PP |
694 | return native_bt.component_get_logging_level(ptr) |
695 | ||
811644b8 | 696 | @property |
e8ac1aae | 697 | def cls(self): |
85906b6b FD |
698 | comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) |
699 | cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr) | |
615238be | 700 | return _create_component_class_from_const_ptr_and_get_ref( |
cfbd7cf3 FD |
701 | cc_ptr, self._bt_comp_cls_type |
702 | ) | |
81447b5b | 703 | |
81447b5b PP |
704 | @property |
705 | def addr(self): | |
85906b6b | 706 | return int(self._bt_ptr) |
81447b5b | 707 | |
056deb59 PP |
708 | @property |
709 | def _graph_mip_version(self): | |
710 | ptr = self._bt_as_self_component_ptr(self._bt_ptr) | |
711 | return native_bt.self_component_get_graph_mip_version(ptr) | |
712 | ||
59225a3e | 713 | def __init__(self, config, params, obj): |
81447b5b PP |
714 | pass |
715 | ||
6a91742b | 716 | def _user_finalize(self): |
81447b5b PP |
717 | pass |
718 | ||
6a91742b | 719 | def _user_port_connected(self, port, other_port): |
811644b8 | 720 | pass |
81447b5b | 721 | |
cfbd7cf3 FD |
722 | def _bt_port_connected_from_native( |
723 | self, self_port_ptr, self_port_type, other_port_ptr | |
724 | ): | |
3fb99a22 | 725 | port = bt2_port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type) |
2c67587a SM |
726 | |
727 | if self_port_type == native_bt.PORT_TYPE_OUTPUT: | |
728 | other_port_type = native_bt.PORT_TYPE_INPUT | |
729 | else: | |
730 | other_port_type = native_bt.PORT_TYPE_OUTPUT | |
731 | ||
5813b3a3 | 732 | other_port = bt2_port._create_from_const_ptr_and_get_ref( |
cfbd7cf3 FD |
733 | other_port_ptr, other_port_type |
734 | ) | |
6a91742b | 735 | self._user_port_connected(port, other_port) |
81447b5b | 736 | |
5783664e PP |
737 | def _create_trace_class( |
738 | self, user_attributes=None, assigns_automatic_stream_class_id=True | |
739 | ): | |
85906b6b | 740 | ptr = self._bt_as_self_component_ptr(self._bt_ptr) |
fbbe9302 SM |
741 | tc_ptr = native_bt.trace_class_create(ptr) |
742 | ||
743 | if tc_ptr is None: | |
694c792b | 744 | raise bt2._MemoryError('could not create trace class') |
fbbe9302 | 745 | |
3fb99a22 | 746 | tc = bt2_trace_class._TraceClass._create_from_ptr(tc_ptr) |
fbbe9302 SM |
747 | tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id |
748 | ||
5783664e PP |
749 | if user_attributes is not None: |
750 | tc._user_attributes = user_attributes | |
751 | ||
fbbe9302 SM |
752 | return tc |
753 | ||
cfbd7cf3 FD |
754 | def _create_clock_class( |
755 | self, | |
756 | frequency=None, | |
757 | name=None, | |
5783664e | 758 | user_attributes=None, |
cfbd7cf3 FD |
759 | description=None, |
760 | precision=None, | |
761 | offset=None, | |
762 | origin_is_unix_epoch=True, | |
763 | uuid=None, | |
764 | ): | |
85906b6b | 765 | ptr = self._bt_as_self_component_ptr(self._bt_ptr) |
3cdfbaea SM |
766 | cc_ptr = native_bt.clock_class_create(ptr) |
767 | ||
768 | if cc_ptr is None: | |
694c792b | 769 | raise bt2._MemoryError('could not create clock class') |
3cdfbaea | 770 | |
3fb99a22 | 771 | cc = bt2_clock_class._ClockClass._create_from_ptr(cc_ptr) |
2ae9f48c SM |
772 | |
773 | if frequency is not None: | |
774 | cc._frequency = frequency | |
775 | ||
be7bbff9 SM |
776 | if name is not None: |
777 | cc._name = name | |
778 | ||
5783664e PP |
779 | if user_attributes is not None: |
780 | cc._user_attributes = user_attributes | |
781 | ||
be7bbff9 SM |
782 | if description is not None: |
783 | cc._description = description | |
784 | ||
785 | if precision is not None: | |
786 | cc._precision = precision | |
787 | ||
788 | if offset is not None: | |
789 | cc._offset = offset | |
790 | ||
791 | cc._origin_is_unix_epoch = origin_is_unix_epoch | |
792 | ||
793 | if uuid is not None: | |
794 | cc._uuid = uuid | |
795 | ||
2ae9f48c | 796 | return cc |
3cdfbaea | 797 | |
81447b5b | 798 | |
615238be | 799 | class _UserSourceComponent(_UserComponent, _SourceComponentConst): |
cfbd7cf3 FD |
800 | _bt_as_not_self_specific_component_ptr = staticmethod( |
801 | native_bt.self_component_source_as_component_source | |
802 | ) | |
803 | _bt_as_self_component_ptr = staticmethod( | |
804 | native_bt.self_component_source_as_self_component | |
805 | ) | |
59225a3e | 806 | _config_pycls = _UserSourceComponentConfiguration |
1c9ed2ff | 807 | |
81447b5b | 808 | @property |
811644b8 | 809 | def _output_ports(self): |
894a8df5 | 810 | def get_output_port_count(self_ptr): |
85906b6b | 811 | ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) |
894a8df5 SM |
812 | return native_bt.component_source_get_output_port_count(ptr) |
813 | ||
cfbd7cf3 FD |
814 | return _ComponentPorts( |
815 | self._bt_ptr, | |
816 | native_bt.self_component_source_borrow_output_port_by_name, | |
817 | native_bt.self_component_source_borrow_output_port_by_index, | |
818 | get_output_port_count, | |
3fb99a22 | 819 | bt2_port._UserComponentOutputPort, |
cfbd7cf3 | 820 | ) |
811644b8 | 821 | |
2e00bc76 | 822 | def _add_output_port(self, name, user_data=None): |
811644b8 | 823 | utils._check_str(name) |
894a8df5 | 824 | fn = native_bt.self_component_source_add_output_port |
85906b6b | 825 | comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) |
cfbd7cf3 FD |
826 | utils._handle_func_status( |
827 | comp_status, 'cannot add output port to source component object' | |
828 | ) | |
894a8df5 | 829 | assert self_port_ptr is not None |
a91462c9 PP |
830 | return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref( |
831 | self_port_ptr | |
832 | ) | |
811644b8 PP |
833 | |
834 | ||
615238be | 835 | class _UserFilterComponent(_UserComponent, _FilterComponentConst): |
cfbd7cf3 FD |
836 | _bt_as_not_self_specific_component_ptr = staticmethod( |
837 | native_bt.self_component_filter_as_component_filter | |
838 | ) | |
839 | _bt_as_self_component_ptr = staticmethod( | |
840 | native_bt.self_component_filter_as_self_component | |
841 | ) | |
59225a3e | 842 | _config_pycls = _UserFilterComponentConfiguration |
1c9ed2ff | 843 | |
811644b8 PP |
844 | @property |
845 | def _output_ports(self): | |
894a8df5 | 846 | def get_output_port_count(self_ptr): |
85906b6b | 847 | ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) |
894a8df5 SM |
848 | return native_bt.component_filter_get_output_port_count(ptr) |
849 | ||
cfbd7cf3 FD |
850 | return _ComponentPorts( |
851 | self._bt_ptr, | |
852 | native_bt.self_component_filter_borrow_output_port_by_name, | |
853 | native_bt.self_component_filter_borrow_output_port_by_index, | |
854 | get_output_port_count, | |
3fb99a22 | 855 | bt2_port._UserComponentOutputPort, |
cfbd7cf3 | 856 | ) |
81447b5b | 857 | |
811644b8 PP |
858 | @property |
859 | def _input_ports(self): | |
894a8df5 | 860 | def get_input_port_count(self_ptr): |
85906b6b | 861 | ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) |
894a8df5 SM |
862 | return native_bt.component_filter_get_input_port_count(ptr) |
863 | ||
cfbd7cf3 FD |
864 | return _ComponentPorts( |
865 | self._bt_ptr, | |
866 | native_bt.self_component_filter_borrow_input_port_by_name, | |
867 | native_bt.self_component_filter_borrow_input_port_by_index, | |
868 | get_input_port_count, | |
3fb99a22 | 869 | bt2_port._UserComponentInputPort, |
cfbd7cf3 | 870 | ) |
811644b8 | 871 | |
2e00bc76 | 872 | def _add_output_port(self, name, user_data=None): |
811644b8 | 873 | utils._check_str(name) |
894a8df5 | 874 | fn = native_bt.self_component_filter_add_output_port |
85906b6b | 875 | comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) |
cfbd7cf3 FD |
876 | utils._handle_func_status( |
877 | comp_status, 'cannot add output port to filter component object' | |
878 | ) | |
894a8df5 | 879 | assert self_port_ptr |
a91462c9 PP |
880 | return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref( |
881 | self_port_ptr | |
882 | ) | |
811644b8 | 883 | |
2e00bc76 | 884 | def _add_input_port(self, name, user_data=None): |
811644b8 | 885 | utils._check_str(name) |
894a8df5 | 886 | fn = native_bt.self_component_filter_add_input_port |
85906b6b | 887 | comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) |
cfbd7cf3 FD |
888 | utils._handle_func_status( |
889 | comp_status, 'cannot add input port to filter component object' | |
890 | ) | |
894a8df5 | 891 | assert self_port_ptr |
a91462c9 PP |
892 | return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref( |
893 | self_port_ptr | |
894 | ) | |
811644b8 PP |
895 | |
896 | ||
615238be | 897 | class _UserSinkComponent(_UserComponent, _SinkComponentConst): |
cfbd7cf3 FD |
898 | _bt_as_not_self_specific_component_ptr = staticmethod( |
899 | native_bt.self_component_sink_as_component_sink | |
900 | ) | |
901 | _bt_as_self_component_ptr = staticmethod( | |
902 | native_bt.self_component_sink_as_self_component | |
903 | ) | |
59225a3e | 904 | _config_pycls = _UserSinkComponentConfiguration |
1c9ed2ff | 905 | |
d14a864a | 906 | def _bt_graph_is_configured_from_native(self): |
6a91742b | 907 | self._user_graph_is_configured() |
d14a864a | 908 | |
6a91742b | 909 | def _user_graph_is_configured(self): |
cd1ef6f2 PP |
910 | pass |
911 | ||
811644b8 PP |
912 | @property |
913 | def _input_ports(self): | |
894a8df5 | 914 | def get_input_port_count(self_ptr): |
85906b6b | 915 | ptr = self._bt_as_not_self_specific_component_ptr(self_ptr) |
894a8df5 SM |
916 | return native_bt.component_sink_get_input_port_count(ptr) |
917 | ||
cfbd7cf3 FD |
918 | return _ComponentPorts( |
919 | self._bt_ptr, | |
920 | native_bt.self_component_sink_borrow_input_port_by_name, | |
921 | native_bt.self_component_sink_borrow_input_port_by_index, | |
922 | get_input_port_count, | |
3fb99a22 | 923 | bt2_port._UserComponentInputPort, |
cfbd7cf3 | 924 | ) |
811644b8 | 925 | |
2e00bc76 | 926 | def _add_input_port(self, name, user_data=None): |
811644b8 | 927 | utils._check_str(name) |
894a8df5 | 928 | fn = native_bt.self_component_sink_add_input_port |
85906b6b | 929 | comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data) |
cfbd7cf3 FD |
930 | utils._handle_func_status( |
931 | comp_status, 'cannot add input port to sink component object' | |
932 | ) | |
5f25509b | 933 | assert self_port_ptr |
a91462c9 PP |
934 | return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref( |
935 | self_port_ptr | |
936 | ) | |
ca02df0a | 937 | |
9a2c8b8e | 938 | def _create_message_iterator(self, input_port): |
3fb99a22 | 939 | utils._check_type(input_port, bt2_port._UserComponentInputPort) |
ca02df0a | 940 | |
75882e97 FD |
941 | ( |
942 | status, | |
943 | msg_iter_ptr, | |
9a2c8b8e | 944 | ) = native_bt.bt2_message_iterator_create_from_sink_component( |
ca02df0a PP |
945 | self._bt_ptr, input_port._ptr |
946 | ) | |
e803df70 SM |
947 | utils._handle_func_status(status, 'cannot create message iterator object') |
948 | assert msg_iter_ptr is not None | |
ca02df0a | 949 | |
3fb99a22 | 950 | return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr) |
9b4f9b42 PP |
951 | |
952 | @property | |
953 | def _is_interrupted(self): | |
954 | return bool(native_bt.self_component_sink_is_interrupted(self._bt_ptr)) |