X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fcomponent.py;h=97446a830e5d902359e171830e33f77a8ecf0df2;hp=ef86bbcf50f1f42028e4789208e6222c6e90601b;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=cfbd7cf3bde05e8a6606478889dcd663604ef7b5 diff --git a/src/bindings/python/bt2/bt2/component.py b/src/bindings/python/bt2/bt2/component.py index ef86bbcf..97446a83 100644 --- a/src/bindings/python/bt2/bt2/component.py +++ b/src/bindings/python/bt2/bt2/component.py @@ -1,34 +1,17 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils -import bt2.message_iterator +from bt2 import message_iterator as bt2_message_iterator import collections.abc -import bt2.value -import traceback -import bt2.port +from bt2 import value as bt2_value +from bt2 import trace_class as bt2_trace_class +from bt2 import clock_class as bt2_clock_class +from bt2 import query_executor as bt2_query_executor +from bt2 import port as bt2_port import sys import bt2 -import os # This class wraps a component class pointer. This component class could @@ -42,7 +25,7 @@ import os # pointer to a 'bt_component_class *'. -class _GenericComponentClass(object._SharedObject): +class _ComponentClassConst(object._SharedObject): @property def name(self): ptr = self._bt_as_component_class_ptr(self._ptr) @@ -64,7 +47,7 @@ class _GenericComponentClass(object._SharedObject): return self._bt_as_component_class_ptr(self._ptr) def __eq__(self, other): - if not isinstance(other, _GenericComponentClass): + if not isinstance(other, _ComponentClassConst): try: if not issubclass(other, _UserComponent): return False @@ -74,7 +57,7 @@ class _GenericComponentClass(object._SharedObject): return self.addr == other.addr -class _GenericSourceComponentClass(_GenericComponentClass): +class _SourceComponentClassConst(_ComponentClassConst): _get_ref = staticmethod(native_bt.component_class_source_get_ref) _put_ref = staticmethod(native_bt.component_class_source_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -82,7 +65,7 @@ class _GenericSourceComponentClass(_GenericComponentClass): ) -class _GenericFilterComponentClass(_GenericComponentClass): +class _FilterComponentClassConst(_ComponentClassConst): _get_ref = staticmethod(native_bt.component_class_filter_get_ref) _put_ref = staticmethod(native_bt.component_class_filter_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -90,7 +73,7 @@ class _GenericFilterComponentClass(_GenericComponentClass): ) -class _GenericSinkComponentClass(_GenericComponentClass): +class _SinkComponentClassConst(_ComponentClassConst): _get_ref = staticmethod(native_bt.component_class_sink_get_ref) _put_ref = staticmethod(native_bt.component_class_sink_put_ref) _bt_as_component_class_ptr = staticmethod( @@ -172,7 +155,7 @@ class _ComponentPorts(collections.abc.Mapping): # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'. -class _Component: +class _ComponentConst: @property def name(self): ptr = self._bt_as_component_ptr(self._ptr) @@ -189,7 +172,7 @@ class _Component: def cls(self): cc_ptr = self._bt_borrow_component_class_ptr(self._ptr) assert cc_ptr is not None - return _create_component_class_from_ptr_and_get_ref( + return _create_component_class_from_const_ptr_and_get_ref( cc_ptr, self._bt_comp_cls_type ) @@ -200,7 +183,7 @@ class _Component: return self.addr == other.addr -class _SourceComponent(_Component): +class _SourceComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_source_borrow_class_const ) @@ -211,7 +194,7 @@ class _SourceComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const) -class _FilterComponent(_Component): +class _FilterComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_filter_borrow_class_const ) @@ -222,7 +205,7 @@ class _FilterComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const) -class _SinkComponent(_Component): +class _SinkComponentConst(_ComponentConst): _bt_borrow_component_class_ptr = staticmethod( native_bt.component_sink_borrow_class_const ) @@ -233,9 +216,9 @@ class _SinkComponent(_Component): _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const) -# This is analogous to _GenericSourceComponentClass, but for source +# This is analogous to _SourceComponentClassConst, but for source # component objects. -class _GenericSourceComponent(object._SharedObject, _SourceComponent): +class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst): _get_ref = staticmethod(native_bt.component_source_get_ref) _put_ref = staticmethod(native_bt.component_source_put_ref) @@ -246,13 +229,13 @@ class _GenericSourceComponent(object._SharedObject, _SourceComponent): native_bt.component_source_borrow_output_port_by_name_const, native_bt.component_source_borrow_output_port_by_index_const, native_bt.component_source_get_output_port_count, - bt2.port._OutputPort, + bt2_port._OutputPortConst, ) -# This is analogous to _GenericFilterComponentClass, but for filter +# This is analogous to _FilterComponentClassConst, but for filter # component objects. -class _GenericFilterComponent(object._SharedObject, _FilterComponent): +class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst): _get_ref = staticmethod(native_bt.component_filter_get_ref) _put_ref = staticmethod(native_bt.component_filter_put_ref) @@ -263,7 +246,7 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent): native_bt.component_filter_borrow_output_port_by_name_const, native_bt.component_filter_borrow_output_port_by_index_const, native_bt.component_filter_get_output_port_count, - bt2.port._OutputPort, + bt2_port._OutputPortConst, ) @property @@ -273,13 +256,13 @@ class _GenericFilterComponent(object._SharedObject, _FilterComponent): native_bt.component_filter_borrow_input_port_by_name_const, native_bt.component_filter_borrow_input_port_by_index_const, native_bt.component_filter_get_input_port_count, - bt2.port._InputPort, + bt2_port._InputPortConst, ) -# This is analogous to _GenericSinkComponentClass, but for sink +# This is analogous to _SinkComponentClassConst, but for sink # component objects. -class _GenericSinkComponent(object._SharedObject, _SinkComponent): +class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst): _get_ref = staticmethod(native_bt.component_sink_get_ref) _put_ref = staticmethod(native_bt.component_sink_put_ref) @@ -290,32 +273,32 @@ class _GenericSinkComponent(object._SharedObject, _SinkComponent): native_bt.component_sink_borrow_input_port_by_name_const, native_bt.component_sink_borrow_input_port_by_index_const, native_bt.component_sink_get_input_port_count, - bt2.port._InputPort, + bt2_port._InputPortConst, ) _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = { - native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponent, - native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponent, - native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponent, + native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentConst, + native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentConst, + native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentConst, } _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = { - native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentClass, - native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentClass, - native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentClass, + native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClassConst, + native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClassConst, + native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClassConst, } -# Create a component Python object of type _GenericSourceComponent, -# _GenericFilterComponent or _GenericSinkComponent, depending on +# Create a component Python object of type _GenericSourceComponentConst, +# _GenericFilterComponentConst or _GenericSinkComponentConst, depending on # comp_cls_type. # # Steals the reference to ptr from the caller. -def _create_component_from_ptr(ptr, comp_cls_type): +def _create_component_from_const_ptr(ptr, comp_cls_type): return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr) @@ -323,20 +306,20 @@ def _create_component_from_ptr(ptr, comp_cls_type): # reference from the caller. -def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type): +def _create_component_from_const_ptr_and_get_ref(ptr, comp_cls_type): return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[ comp_cls_type ]._create_from_ptr_and_get_ref(ptr) # Create a component class Python object of type -# _GenericSourceComponentClass, _GenericFilterComponentClass or -# _GenericSinkComponentClass, depending on comp_cls_type. +# _SourceComponentClassConst, _FilterComponentClassConst or +# _SinkComponentClassConst, depending on comp_cls_type. # # Acquires a new reference to ptr. -def _create_component_class_from_ptr_and_get_ref(ptr, comp_cls_type): +def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type): return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[ comp_cls_type ]._create_from_ptr_and_get_ref(ptr) @@ -379,7 +362,7 @@ def _trim_docstring(docstring): # creates a native BT component class of the corresponding type and # associates it with this user-defined class. The metaclass also defines # class methods like the `name` and `description` properties to match -# the _GenericComponentClass interface. +# the _ComponentClassConst interface. # # The component class name which is used is either: # @@ -481,16 +464,9 @@ class _UserComponentType(type): cls, comp_cls_name, comp_cls_descr, comp_cls_help ) elif _UserSinkComponent in bases: - if not hasattr(cls, '_graph_is_configured'): - raise bt2.IncompleteUserClass( - "cannot create component class '{}': missing a _graph_is_configured() method".format( - class_name - ) - ) - - if not hasattr(cls, '_consume'): - raise bt2.IncompleteUserClass( - "cannot create component class '{}': missing a _consume() method".format( + if not hasattr(cls, '_user_consume'): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': missing a _user_consume() method".format( class_name ) ) @@ -499,63 +475,84 @@ class _UserComponentType(type): cls, comp_cls_name, comp_cls_descr, comp_cls_help ) else: - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot find a known component class base in the bases of '{}'".format( class_name ) ) if cc_ptr is None: - raise bt2.CreationError( + raise bt2._MemoryError( "cannot create component class '{}'".format(class_name) ) cls._bt_cc_ptr = cc_ptr - def _bt_init_from_native(cls, comp_ptr, params_ptr): + def _bt_init_from_native(cls, comp_ptr, params_ptr, obj): # create instance, not user-initialized yet self = cls.__new__(cls) + # config object + config = cls._config_pycls() + # pointer to native self component object (weak/borrowed) self._bt_ptr = comp_ptr # call user's __init__() method if params_ptr is not None: - params = bt2.value._create_from_ptr_and_get_ref(params_ptr) + params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) else: params = None - self.__init__(params) + self.__init__(config, params, obj) return self def __call__(cls, *args, **kwargs): - raise bt2.Error( + raise RuntimeError( 'cannot directly instantiate a user component from a Python module' ) @staticmethod def _bt_set_iterator_class(cls, iter_cls): if iter_cls is None: - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot create component class '{}': missing message iterator class".format( cls.__name__ ) ) - if not issubclass(iter_cls, bt2.message_iterator._UserMessageIterator): - raise bt2.IncompleteUserClass( + if not issubclass(iter_cls, bt2_message_iterator._UserMessageIterator): + raise bt2._IncompleteUserClass( "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format( cls.__name__ ) ) if not hasattr(iter_cls, '__next__'): - raise bt2.IncompleteUserClass( + raise bt2._IncompleteUserClass( "cannot create component class '{}': message iterator class is missing a __next__() method".format( cls.__name__ ) ) + if hasattr(iter_cls, '_user_can_seek_ns_from_origin') and not hasattr( + iter_cls, '_user_seek_ns_from_origin' + ): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin".format( + cls.__name__ + ) + ) + + if hasattr(iter_cls, '_user_can_seek_beginning') and not hasattr( + iter_cls, '_user_seek_beginning' + ): + raise bt2._IncompleteUserClass( + "cannot create component class '{}': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning".format( + cls.__name__ + ) + ) + cls._iter_cls = iter_cls @property @@ -577,18 +574,49 @@ class _UserComponentType(type): def addr(cls): return int(cls._bt_cc_ptr) - def _bt_query_from_native(cls, query_exec_ptr, obj, params_ptr, log_level): - # this can raise, in which case the native call to - # bt_component_class_query() returns NULL + def _bt_get_supported_mip_versions_from_native(cls, params_ptr, obj, log_level): + # this can raise, but the native side checks the exception if params_ptr is not None: - params = bt2.value._create_from_ptr_and_get_ref(params_ptr) + params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) else: params = None - query_exec = bt2.QueryExecutor._create_from_ptr_and_get_ref(query_exec_ptr) + # this can raise, but the native side checks the exception + range_set = cls._user_get_supported_mip_versions(params, obj, log_level) + + if type(range_set) is not bt2.UnsignedIntegerRangeSet: + # this can raise, but the native side checks the exception + range_set = bt2.UnsignedIntegerRangeSet(range_set) + + # return new reference + range_set._get_ref(range_set._ptr) + return int(range_set._ptr) + def _user_get_supported_mip_versions(cls, params, obj, log_level): + return [0] + + def _bt_query_from_native( + cls, priv_query_exec_ptr, object_name, params_ptr, method_obj + ): # this can raise, but the native side checks the exception - results = cls._query(query_exec, obj, params, log_level) + if params_ptr is not None: + params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr) + else: + params = None + + priv_query_exec = bt2_query_executor._PrivateQueryExecutor(priv_query_exec_ptr) + + try: + # this can raise, but the native side checks the exception + results = cls._user_query(priv_query_exec, object_name, params, method_obj) + finally: + # the private query executor is a private view on the query + # executor; it's not a shared object (the library does not + # offer an API to get/put a reference, just like "self" + # objects) from this query's point of view, so invalidate + # the object in case the user kept a reference and uses it + # later + priv_query_exec._invalidate() # this can raise, but the native side checks the exception results = bt2.create_value(results) @@ -596,16 +624,14 @@ class _UserComponentType(type): if results is None: results_ptr = native_bt.value_null else: - # return new reference results_ptr = results._ptr - # We return a new reference. - bt2.value._Value._get_ref(results_ptr) - + # return new reference + bt2_value._Value._get_ref(results_ptr) return int(results_ptr) - def _query(cls, query_executor, obj, params, log_level): - raise NotImplementedError + def _user_query(cls, priv_query_executor, object_name, params, method_obj): + raise bt2.UnknownObject def _bt_component_class_ptr(self): return self._bt_as_component_class_ptr(self._bt_cc_ptr) @@ -614,6 +640,30 @@ class _UserComponentType(type): if hasattr(cls, '_bt_cc_ptr'): cc_ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr) native_bt.component_class_put_ref(cc_ptr) + native_bt.bt2_unregister_cc_ptr_to_py_cls(cc_ptr) + + +# Configuration objects for components. +# +# These are passed in __init__ to allow components to change some configuration +# parameters during initialization and not after. As you can see, they are not +# used at the moment, but are there in case we want to add such parameters. + + +class _UserComponentConfiguration: + pass + + +class _UserSourceComponentConfiguration(_UserComponentConfiguration): + pass + + +class _UserFilterComponentConfiguration(_UserComponentConfiguration): + pass + + +class _UserSinkComponentConfiguration(_UserComponentConfiguration): + pass # Subclasses must provide these methods or property: @@ -647,7 +697,7 @@ class _UserComponent(metaclass=_UserComponentType): def cls(self): comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr) cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr) - return _create_component_class_from_ptr_and_get_ref( + return _create_component_class_from_const_ptr_and_get_ref( cc_ptr, self._bt_comp_cls_type ) @@ -655,49 +705,57 @@ class _UserComponent(metaclass=_UserComponentType): def addr(self): return int(self._bt_ptr) - def __init__(self, params=None): + @property + def _graph_mip_version(self): + ptr = self._bt_as_self_component_ptr(self._bt_ptr) + return native_bt.self_component_get_graph_mip_version(ptr) + + def __init__(self, config, params, obj): pass - def _finalize(self): + def _user_finalize(self): pass - def _port_connected(self, port, other_port): + def _user_port_connected(self, port, other_port): pass def _bt_port_connected_from_native( self, self_port_ptr, self_port_type, other_port_ptr ): - port = bt2.port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type) + port = bt2_port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type) if self_port_type == native_bt.PORT_TYPE_OUTPUT: other_port_type = native_bt.PORT_TYPE_INPUT else: other_port_type = native_bt.PORT_TYPE_OUTPUT - other_port = bt2.port._create_from_ptr_and_get_ref( + other_port = bt2_port._create_from_const_ptr_and_get_ref( other_port_ptr, other_port_type ) - self._port_connected(port, other_port) + self._user_port_connected(port, other_port) - def _bt_graph_is_configured_from_native(self): - self._graph_is_configured() - - def _create_trace_class(self, assigns_automatic_stream_class_id=True): + def _create_trace_class( + self, user_attributes=None, assigns_automatic_stream_class_id=True + ): ptr = self._bt_as_self_component_ptr(self._bt_ptr) tc_ptr = native_bt.trace_class_create(ptr) if tc_ptr is None: - raise bt2.CreationError('could not create trace class') + raise bt2._MemoryError('could not create trace class') - tc = bt2._TraceClass._create_from_ptr(tc_ptr) + tc = bt2_trace_class._TraceClass._create_from_ptr(tc_ptr) tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id + if user_attributes is not None: + tc._user_attributes = user_attributes + return tc def _create_clock_class( self, frequency=None, name=None, + user_attributes=None, description=None, precision=None, offset=None, @@ -708,9 +766,9 @@ class _UserComponent(metaclass=_UserComponentType): cc_ptr = native_bt.clock_class_create(ptr) if cc_ptr is None: - raise bt2.CreationError('could not create clock class') + raise bt2._MemoryError('could not create clock class') - cc = bt2.clock_class._ClockClass._create_from_ptr(cc_ptr) + cc = bt2_clock_class._ClockClass._create_from_ptr(cc_ptr) if frequency is not None: cc._frequency = frequency @@ -718,6 +776,9 @@ class _UserComponent(metaclass=_UserComponentType): if name is not None: cc._name = name + if user_attributes is not None: + cc._user_attributes = user_attributes + if description is not None: cc._description = description @@ -735,13 +796,14 @@ class _UserComponent(metaclass=_UserComponentType): return cc -class _UserSourceComponent(_UserComponent, _SourceComponent): +class _UserSourceComponent(_UserComponent, _SourceComponentConst): _bt_as_not_self_specific_component_ptr = staticmethod( native_bt.self_component_source_as_component_source ) _bt_as_self_component_ptr = staticmethod( native_bt.self_component_source_as_self_component ) + _config_pycls = _UserSourceComponentConfiguration @property def _output_ports(self): @@ -754,7 +816,7 @@ class _UserSourceComponent(_UserComponent, _SourceComponent): native_bt.self_component_source_borrow_output_port_by_name, native_bt.self_component_source_borrow_output_port_by_index, get_output_port_count, - bt2.port._UserComponentOutputPort, + bt2_port._UserComponentOutputPort, ) def _add_output_port(self, name, user_data=None): @@ -765,16 +827,19 @@ class _UserSourceComponent(_UserComponent, _SourceComponent): comp_status, 'cannot add output port to source component object' ) assert self_port_ptr is not None - return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref( + self_port_ptr + ) -class _UserFilterComponent(_UserComponent, _FilterComponent): +class _UserFilterComponent(_UserComponent, _FilterComponentConst): _bt_as_not_self_specific_component_ptr = staticmethod( native_bt.self_component_filter_as_component_filter ) _bt_as_self_component_ptr = staticmethod( native_bt.self_component_filter_as_self_component ) + _config_pycls = _UserFilterComponentConfiguration @property def _output_ports(self): @@ -787,7 +852,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): native_bt.self_component_filter_borrow_output_port_by_name, native_bt.self_component_filter_borrow_output_port_by_index, get_output_port_count, - bt2.port._UserComponentOutputPort, + bt2_port._UserComponentOutputPort, ) @property @@ -801,7 +866,7 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): native_bt.self_component_filter_borrow_input_port_by_name, native_bt.self_component_filter_borrow_input_port_by_index, get_input_port_count, - bt2.port._UserComponentInputPort, + bt2_port._UserComponentInputPort, ) def _add_output_port(self, name, user_data=None): @@ -812,7 +877,9 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): comp_status, 'cannot add output port to filter component object' ) assert self_port_ptr - return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentOutputPort._create_from_ptr_and_get_ref( + self_port_ptr + ) def _add_input_port(self, name, user_data=None): utils._check_str(name) @@ -822,16 +889,25 @@ class _UserFilterComponent(_UserComponent, _FilterComponent): comp_status, 'cannot add input port to filter component object' ) assert self_port_ptr - return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref( + self_port_ptr + ) -class _UserSinkComponent(_UserComponent, _SinkComponent): +class _UserSinkComponent(_UserComponent, _SinkComponentConst): _bt_as_not_self_specific_component_ptr = staticmethod( native_bt.self_component_sink_as_component_sink ) _bt_as_self_component_ptr = staticmethod( native_bt.self_component_sink_as_self_component ) + _config_pycls = _UserSinkComponentConfiguration + + def _bt_graph_is_configured_from_native(self): + self._user_graph_is_configured() + + def _user_graph_is_configured(self): + pass @property def _input_ports(self): @@ -844,7 +920,7 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): native_bt.self_component_sink_borrow_input_port_by_name, native_bt.self_component_sink_borrow_input_port_by_index, get_input_port_count, - bt2.port._UserComponentInputPort, + bt2_port._UserComponentInputPort, ) def _add_input_port(self, name, user_data=None): @@ -855,4 +931,24 @@ class _UserSinkComponent(_UserComponent, _SinkComponent): comp_status, 'cannot add input port to sink component object' ) assert self_port_ptr - return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr) + return bt2_port._UserComponentInputPort._create_from_ptr_and_get_ref( + self_port_ptr + ) + + def _create_message_iterator(self, input_port): + utils._check_type(input_port, bt2_port._UserComponentInputPort) + + ( + status, + msg_iter_ptr, + ) = native_bt.bt2_message_iterator_create_from_sink_component( + self._bt_ptr, input_port._ptr + ) + utils._handle_func_status(status, 'cannot create message iterator object') + assert msg_iter_ptr is not None + + return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr) + + @property + def _is_interrupted(self): + return bool(native_bt.self_component_sink_is_interrupted(self._bt_ptr))