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
24 import bt2
.message_iterator
25 import collections
.abc
34 # This class wraps a component class pointer. This component class could
35 # have been created by Python code, but since we only have the pointer,
36 # we can only wrap it in a generic way and lose the original Python
39 # Subclasses must implement some methods that this base class uses:
41 # - _bt_as_component_class_ptr: static method, convert the passed component class
42 # pointer to a 'bt_component_class *'.
44 class _GenericComponentClass(object._SharedObject
):
47 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
48 name
= native_bt
.component_class_get_name(ptr
)
49 assert name
is not None
53 def description(self
):
54 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
55 return native_bt
.component_class_get_description(ptr
)
59 ptr
= self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
60 return native_bt
.component_class_get_help(ptr
)
62 def _bt_component_class_ptr(self
):
63 return self
._bt
_as
_component
_class
_ptr
(self
._ptr
)
65 def __eq__(self
, other
):
66 if not isinstance(other
, _GenericComponentClass
):
68 if not issubclass(other
, _UserComponent
):
73 return self
.addr
== other
.addr
76 class _GenericSourceComponentClass(_GenericComponentClass
):
77 _get_ref
= staticmethod(native_bt
.component_class_source_get_ref
)
78 _put_ref
= staticmethod(native_bt
.component_class_source_put_ref
)
79 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_source_as_component_class
)
82 class _GenericFilterComponentClass(_GenericComponentClass
):
83 _get_ref
= staticmethod(native_bt
.component_class_filter_get_ref
)
84 _put_ref
= staticmethod(native_bt
.component_class_filter_put_ref
)
85 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_filter_as_component_class
)
88 class _GenericSinkComponentClass(_GenericComponentClass
):
89 _get_ref
= staticmethod(native_bt
.component_class_sink_get_ref
)
90 _put_ref
= staticmethod(native_bt
.component_class_sink_put_ref
)
91 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_sink_as_component_class
)
94 class _PortIterator(collections
.abc
.Iterator
):
95 def __init__(self
, comp_ports
):
96 self
._comp
_ports
= comp_ports
100 if self
._at
== len(self
._comp
_ports
):
103 comp_ports
= self
._comp
_ports
104 comp_ptr
= comp_ports
._component
_ptr
106 port_ptr
= comp_ports
._borrow
_port
_ptr
_at
_index
(comp_ptr
, self
._at
)
107 assert port_ptr
is not None
109 name
= native_bt
.port_get_name(comp_ports
._port
_pycls
._as
_port
_ptr
(port_ptr
))
110 assert name
is not None
116 class _ComponentPorts(collections
.abc
.Mapping
):
118 # component_ptr is a bt_component_source *, bt_component_filter * or
119 # bt_component_sink *. Its type must match the type expected by the
120 # functions passed as arguments.
122 def __init__(self
, component_ptr
,
123 borrow_port_ptr_by_name
,
124 borrow_port_ptr_at_index
,
127 self
._component
_ptr
= component_ptr
128 self
._borrow
_port
_ptr
_by
_name
= borrow_port_ptr_by_name
129 self
._borrow
_port
_ptr
_at
_index
= borrow_port_ptr_at_index
130 self
._get
_port
_count
= get_port_count
131 self
._port
_pycls
= port_pycls
133 def __getitem__(self
, key
):
134 utils
._check
_str
(key
)
135 port_ptr
= self
._borrow
_port
_ptr
_by
_name
(self
._component
_ptr
, key
)
140 return self
._port
_pycls
._create
_from
_ptr
_and
_get
_ref
(port_ptr
)
143 count
= self
._get
_port
_count
(self
._component
_ptr
)
148 return _PortIterator(self
)
151 # This class holds the methods which are common to both generic
152 # component objects and Python user component objects.
154 # Subclasses must provide these methods or property:
156 # - _bt_borrow_component_class_ptr: static method, must return a pointer to the
157 # specialized component class (e.g. 'bt_component_class_sink *') of the
158 # passed specialized component pointer (e.g. 'bt_component_sink *').
159 # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
161 # - _bt_as_component_ptr: static method, must return the passed specialized
162 # component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'.
167 ptr
= self
._bt
_as
_component
_ptr
(self
._ptr
)
168 name
= native_bt
.component_get_name(ptr
)
169 assert name
is not None
173 def logging_level(self
):
174 ptr
= self
._bt
_as
_component
_ptr
(self
._ptr
)
175 return native_bt
.component_get_logging_level(ptr
)
179 cc_ptr
= self
._bt
_borrow
_component
_class
_ptr
(self
._ptr
)
180 assert cc_ptr
is not None
181 return _create_component_class_from_ptr_and_get_ref(cc_ptr
, self
._bt
_comp
_cls
_type
)
183 def __eq__(self
, other
):
184 if not hasattr(other
, 'addr'):
187 return self
.addr
== other
.addr
190 class _SourceComponent(_Component
):
191 _bt_borrow_component_class_ptr
= staticmethod(native_bt
.component_source_borrow_class_const
)
192 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
193 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_source_as_component_class
)
194 _bt_as_component_ptr
= staticmethod(native_bt
.component_source_as_component_const
)
197 class _FilterComponent(_Component
):
198 _bt_borrow_component_class_ptr
= staticmethod(native_bt
.component_filter_borrow_class_const
)
199 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
200 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_filter_as_component_class
)
201 _bt_as_component_ptr
= staticmethod(native_bt
.component_filter_as_component_const
)
204 class _SinkComponent(_Component
):
205 _bt_borrow_component_class_ptr
= staticmethod(native_bt
.component_sink_borrow_class_const
)
206 _bt_comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
207 _bt_as_component_class_ptr
= staticmethod(native_bt
.component_class_sink_as_component_class
)
208 _bt_as_component_ptr
= staticmethod(native_bt
.component_sink_as_component_const
)
211 # This is analogous to _GenericSourceComponentClass, but for source
213 class _GenericSourceComponent(object._SharedObject
, _SourceComponent
):
214 _get_ref
= staticmethod(native_bt
.component_source_get_ref
)
215 _put_ref
= staticmethod(native_bt
.component_source_put_ref
)
218 def output_ports(self
):
219 return _ComponentPorts(self
._ptr
,
220 native_bt
.component_source_borrow_output_port_by_name_const
,
221 native_bt
.component_source_borrow_output_port_by_index_const
,
222 native_bt
.component_source_get_output_port_count
,
223 bt2
.port
._OutputPort
)
226 # This is analogous to _GenericFilterComponentClass, but for filter
228 class _GenericFilterComponent(object._SharedObject
, _FilterComponent
):
229 _get_ref
= staticmethod(native_bt
.component_filter_get_ref
)
230 _put_ref
= staticmethod(native_bt
.component_filter_put_ref
)
233 def output_ports(self
):
234 return _ComponentPorts(self
._ptr
,
235 native_bt
.component_filter_borrow_output_port_by_name_const
,
236 native_bt
.component_filter_borrow_output_port_by_index_const
,
237 native_bt
.component_filter_get_output_port_count
,
238 bt2
.port
._OutputPort
)
241 def input_ports(self
):
242 return _ComponentPorts(self
._ptr
,
243 native_bt
.component_filter_borrow_input_port_by_name_const
,
244 native_bt
.component_filter_borrow_input_port_by_index_const
,
245 native_bt
.component_filter_get_input_port_count
,
249 # This is analogous to _GenericSinkComponentClass, but for sink
251 class _GenericSinkComponent(object._SharedObject
, _SinkComponent
):
252 _get_ref
= staticmethod(native_bt
.component_sink_get_ref
)
253 _put_ref
= staticmethod(native_bt
.component_sink_put_ref
)
256 def input_ports(self
):
257 return _ComponentPorts(self
._ptr
,
258 native_bt
.component_sink_borrow_input_port_by_name_const
,
259 native_bt
.component_sink_borrow_input_port_by_index_const
,
260 native_bt
.component_sink_get_input_port_count
,
264 _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
= {
265 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _GenericSourceComponent
,
266 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _GenericFilterComponent
,
267 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _GenericSinkComponent
,
271 _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
= {
272 native_bt
.COMPONENT_CLASS_TYPE_SOURCE
: _GenericSourceComponentClass
,
273 native_bt
.COMPONENT_CLASS_TYPE_FILTER
: _GenericFilterComponentClass
,
274 native_bt
.COMPONENT_CLASS_TYPE_SINK
: _GenericSinkComponentClass
,
278 # Create a component Python object of type _GenericSourceComponent,
279 # _GenericFilterComponent or _GenericSinkComponent, depending on
282 # Steals the reference to ptr from the caller.
284 def _create_component_from_ptr(ptr
, comp_cls_type
):
285 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[comp_cls_type
]._create
_from
_ptr
(ptr
)
288 # Same as the above, but acquire a new reference instead of stealing the
289 # reference from the caller.
291 def _create_component_from_ptr_and_get_ref(ptr
, comp_cls_type
):
292 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS
[comp_cls_type
]._create
_from
_ptr
_and
_get
_ref
(ptr
)
295 # Create a component class Python object of type
296 # _GenericSourceComponentClass, _GenericFilterComponentClass or
297 # _GenericSinkComponentClass, depending on comp_cls_type.
299 # Acquires a new reference to ptr.
301 def _create_component_class_from_ptr_and_get_ref(ptr
, comp_cls_type
):
302 return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS
[comp_cls_type
]._create
_from
_ptr
_and
_get
_ref
(ptr
)
305 def _trim_docstring(docstring
):
306 lines
= docstring
.expandtabs().splitlines()
309 for line
in lines
[1:]:
310 stripped
= line
.lstrip()
313 indent
= min(indent
, len(line
) - len(stripped
))
315 trimmed
= [lines
[0].strip()]
317 if indent
< sys
.maxsize
:
318 for line
in lines
[1:]:
319 trimmed
.append(line
[indent
:].rstrip())
321 while trimmed
and not trimmed
[-1]:
324 while trimmed
and not trimmed
[0]:
327 return '\n'.join(trimmed
)
330 # Metaclass for component classes defined by Python code.
332 # The Python user can create a standard Python class which inherits one
333 # of the three base classes (_UserSourceComponent, _UserFilterComponent,
334 # or _UserSinkComponent). Those base classes set this class
335 # (_UserComponentType) as their metaclass.
337 # Once the body of a user-defined component class is executed, this
338 # metaclass is used to create and initialize the class. The metaclass
339 # creates a native BT component class of the corresponding type and
340 # associates it with this user-defined class. The metaclass also defines
341 # class methods like the `name` and `description` properties to match
342 # the _GenericComponentClass interface.
344 # The component class name which is used is either:
346 # * The `name` parameter of the class:
348 # class MySink(bt2.SinkComponent, name='my-custom-sink'):
351 # * If the `name` class parameter is not used: the name of the class
352 # itself (`MySink` in the example above).
354 # The component class description which is used is the user-defined
357 # class MySink(bt2.SinkComponent):
358 # 'Description goes here'
361 # A user-defined Python component class can have an __init__() method
362 # which must at least accept the `params` and `name` arguments:
364 # def __init__(self, params, name, something_else):
367 # The user-defined component class can also have a _finalize() method
368 # (do NOT use __del__()) to be notified when the component object is
371 # User-defined source and filter component classes must use the
372 # `message_iterator_class` class parameter to specify the
373 # message iterator class to use for this component class:
375 # class MyMessageIterator(bt2._UserMessageIterator):
378 # class MySource(bt2._UserSourceComponent,
379 # message_iterator_class=MyMessageIterator):
382 # This message iterator class must inherit
383 # bt2._UserMessageIterator, and it must define the _get() and
384 # _next() methods. The message iterator class can also define an
385 # __init__() method: this method has access to the original Python
386 # component object which was used to create it as the `component`
387 # property. The message iterator class can also define a
388 # _finalize() method (again, do NOT use __del__()): this is called when
389 # the message iterator is (really) destroyed.
391 # When the user-defined class is destroyed, this metaclass's __del__()
392 # method is called: the native BT component class pointer is put (not
393 # needed anymore, at least not by any Python code since all references
394 # are dropped for __del__() to be called).
395 class _UserComponentType(type):
396 # __new__() is used to catch custom class parameters
397 def __new__(meta_cls
, class_name
, bases
, attrs
, **kwargs
):
398 return super().__new
__(meta_cls
, class_name
, bases
, attrs
)
400 def __init__(cls
, class_name
, bases
, namespace
, **kwargs
):
401 super().__init
__(class_name
, bases
, namespace
)
403 # skip our own bases; they are never directly instantiated by the user
406 '_UserFilterSinkComponent',
407 '_UserSourceComponent',
408 '_UserFilterComponent',
409 '_UserSinkComponent',
412 if class_name
in own_bases
:
415 comp_cls_name
= kwargs
.get('name', class_name
)
416 utils
._check
_str
(comp_cls_name
)
417 comp_cls_descr
= None
420 if hasattr(cls
, '__doc__') and cls
.__doc
__ is not None:
421 utils
._check
_str
(cls
.__doc
__)
422 docstring
= _trim_docstring(cls
.__doc
__)
423 lines
= docstring
.splitlines()
426 comp_cls_descr
= lines
[0]
429 comp_cls_help
= '\n'.join(lines
[2:])
431 iter_cls
= kwargs
.get('message_iterator_class')
433 if _UserSourceComponent
in bases
:
434 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
435 cc_ptr
= native_bt
.bt2_component_class_source_create(cls
,
439 elif _UserFilterComponent
in bases
:
440 _UserComponentType
._bt
_set
_iterator
_class
(cls
, iter_cls
)
441 cc_ptr
= native_bt
.bt2_component_class_filter_create(cls
,
445 elif _UserSinkComponent
in bases
:
446 if not hasattr(cls
, '_graph_is_configured'):
447 raise bt2
.IncompleteUserClass("cannot create component class '{}': missing a _graph_is_configured() method".format(class_name
))
449 if not hasattr(cls
, '_consume'):
450 raise bt2
.IncompleteUserClass("cannot create component class '{}': missing a _consume() method".format(class_name
))
452 cc_ptr
= native_bt
.bt2_component_class_sink_create(cls
,
457 raise bt2
.IncompleteUserClass("cannot find a known component class base in the bases of '{}'".format(class_name
))
460 raise bt2
.CreationError("cannot create component class '{}'".format(class_name
))
462 cls
._bt
_cc
_ptr
= cc_ptr
464 def _bt_init_from_native(cls
, comp_ptr
, params_ptr
):
465 # create instance, not user-initialized yet
466 self
= cls
.__new
__(cls
)
468 # pointer to native self component object (weak/borrowed)
469 self
._bt
_ptr
= comp_ptr
471 # call user's __init__() method
472 if params_ptr
is not None:
473 params
= bt2
.value
._create
_from
_ptr
_and
_get
_ref
(params_ptr
)
477 self
.__init
__(params
)
480 def __call__(cls
, *args
, **kwargs
):
481 raise bt2
.Error('cannot directly instantiate a user component from a Python module')
484 def _bt_set_iterator_class(cls
, iter_cls
):
486 raise bt2
.IncompleteUserClass("cannot create component class '{}': missing message iterator class".format(cls
.__name
__))
488 if not issubclass(iter_cls
, bt2
.message_iterator
._UserMessageIterator
):
489 raise bt2
.IncompleteUserClass("cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(cls
.__name
__))
491 if not hasattr(iter_cls
, '__next__'):
492 raise bt2
.IncompleteUserClass("cannot create component class '{}': message iterator class is missing a __next__() method".format(cls
.__name
__))
494 cls
._iter
_cls
= iter_cls
498 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
499 return native_bt
.component_class_get_name(ptr
)
502 def description(cls
):
503 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
504 return native_bt
.component_class_get_description(ptr
)
508 ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
509 return native_bt
.component_class_get_help(ptr
)
513 return int(cls
._bt
_cc
_ptr
)
515 def _bt_query_from_native(cls
, query_exec_ptr
, obj
, params_ptr
, log_level
):
516 # this can raise, in which case the native call to
517 # bt_component_class_query() returns NULL
518 if params_ptr
is not None:
519 params
= bt2
.value
._create
_from
_ptr
_and
_get
_ref
(params_ptr
)
523 query_exec
= bt2
.QueryExecutor
._create
_from
_ptr
_and
_get
_ref
(
526 # this can raise, but the native side checks the exception
527 results
= cls
._query
(query_exec
, obj
, params
, log_level
)
529 # this can raise, but the native side checks the exception
530 results
= bt2
.create_value(results
)
533 results_ptr
= native_bt
.value_null
535 # return new reference
536 results_ptr
= results
._ptr
538 # We return a new reference.
539 bt2
.value
._Value
._get
_ref
(results_ptr
)
541 return int(results_ptr
)
543 def _query(cls
, query_executor
, obj
, params
, log_level
):
544 raise NotImplementedError
546 def _bt_component_class_ptr(self
):
547 return self
._bt
_as
_component
_class
_ptr
(self
._bt
_cc
_ptr
)
550 if hasattr(cls
, '_bt_cc_ptr'):
551 cc_ptr
= cls
._bt
_as
_component
_class
_ptr
(cls
._bt
_cc
_ptr
)
552 native_bt
.component_class_put_ref(cc_ptr
)
554 # Subclasses must provide these methods or property:
556 # - _bt_as_not_self_specific_component_ptr: static method, must return the passed
557 # specialized self component pointer (e.g. 'bt_self_component_sink *') as a
558 # specialized non-self pointer (e.g. 'bt_component_sink *').
559 # - _bt_borrow_component_class_ptr: static method, must return a pointer to the
560 # specialized component class (e.g. 'bt_component_class_sink *') of the
561 # passed specialized component pointer (e.g. 'bt_component_sink *').
562 # - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
565 class _UserComponent(metaclass
=_UserComponentType
):
568 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
569 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
570 name
= native_bt
.component_get_name(ptr
)
571 assert name
is not None
575 def logging_level(self
):
576 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
577 ptr
= self
._bt
_as
_component
_ptr
(ptr
)
578 return native_bt
.component_get_logging_level(ptr
)
582 comp_ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self
._bt
_ptr
)
583 cc_ptr
= self
._bt
_borrow
_component
_class
_ptr
(comp_ptr
)
584 return _create_component_class_from_ptr_and_get_ref(cc_ptr
, self
._bt
_comp
_cls
_type
)
588 return int(self
._bt
_ptr
)
590 def __init__(self
, params
=None):
596 def _port_connected(self
, port
, other_port
):
599 def _bt_port_connected_from_native(self
, self_port_ptr
, self_port_type
, other_port_ptr
):
600 port
= bt2
.port
._create
_self
_from
_ptr
_and
_get
_ref
(
601 self_port_ptr
, self_port_type
)
603 if self_port_type
== native_bt
.PORT_TYPE_OUTPUT
:
604 other_port_type
= native_bt
.PORT_TYPE_INPUT
606 other_port_type
= native_bt
.PORT_TYPE_OUTPUT
608 other_port
= bt2
.port
._create
_from
_ptr
_and
_get
_ref
(
609 other_port_ptr
, other_port_type
)
610 self
._port
_connected
(port
, other_port
)
612 def _bt_graph_is_configured_from_native(self
):
613 self
._graph
_is
_configured
()
615 def _create_trace_class(self
, assigns_automatic_stream_class_id
=True):
616 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
617 tc_ptr
= native_bt
.trace_class_create(ptr
)
620 raise bt2
.CreationError('could not create trace class')
622 tc
= bt2
._TraceClass
._create
_from
_ptr
(tc_ptr
)
623 tc
._assigns
_automatic
_stream
_class
_id
= assigns_automatic_stream_class_id
627 def _create_clock_class(self
, frequency
=None, name
=None, description
=None,
628 precision
=None, offset
=None, origin_is_unix_epoch
=True,
630 ptr
= self
._bt
_as
_self
_component
_ptr
(self
._bt
_ptr
)
631 cc_ptr
= native_bt
.clock_class_create(ptr
)
634 raise bt2
.CreationError('could not create clock class')
636 cc
= bt2
.clock_class
._ClockClass
._create
_from
_ptr
(cc_ptr
)
638 if frequency
is not None:
639 cc
._frequency
= frequency
644 if description
is not None:
645 cc
._description
= description
647 if precision
is not None:
648 cc
._precision
= precision
650 if offset
is not None:
653 cc
._origin
_is
_unix
_epoch
= origin_is_unix_epoch
661 class _UserSourceComponent(_UserComponent
, _SourceComponent
):
662 _bt_as_not_self_specific_component_ptr
= staticmethod(native_bt
.self_component_source_as_component_source
)
663 _bt_as_self_component_ptr
= staticmethod(native_bt
.self_component_source_as_self_component
)
666 def _output_ports(self
):
667 def get_output_port_count(self_ptr
):
668 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
669 return native_bt
.component_source_get_output_port_count(ptr
)
671 return _ComponentPorts(self
._bt
_ptr
,
672 native_bt
.self_component_source_borrow_output_port_by_name
,
673 native_bt
.self_component_source_borrow_output_port_by_index
,
674 get_output_port_count
,
675 bt2
.port
._UserComponentOutputPort
)
677 def _add_output_port(self
, name
, user_data
=None):
678 utils
._check
_str
(name
)
679 fn
= native_bt
.self_component_source_add_output_port
680 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
681 utils
._handle
_func
_status
(comp_status
,
682 'cannot add output port to source component object')
683 assert self_port_ptr
is not None
684 return bt2
.port
._UserComponentOutputPort
._create
_from
_ptr
(self_port_ptr
)
687 class _UserFilterComponent(_UserComponent
, _FilterComponent
):
688 _bt_as_not_self_specific_component_ptr
= staticmethod(native_bt
.self_component_filter_as_component_filter
)
689 _bt_as_self_component_ptr
= staticmethod(native_bt
.self_component_filter_as_self_component
)
692 def _output_ports(self
):
693 def get_output_port_count(self_ptr
):
694 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
695 return native_bt
.component_filter_get_output_port_count(ptr
)
697 return _ComponentPorts(self
._bt
_ptr
,
698 native_bt
.self_component_filter_borrow_output_port_by_name
,
699 native_bt
.self_component_filter_borrow_output_port_by_index
,
700 get_output_port_count
,
701 bt2
.port
._UserComponentOutputPort
)
704 def _input_ports(self
):
705 def get_input_port_count(self_ptr
):
706 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
707 return native_bt
.component_filter_get_input_port_count(ptr
)
709 return _ComponentPorts(self
._bt
_ptr
,
710 native_bt
.self_component_filter_borrow_input_port_by_name
,
711 native_bt
.self_component_filter_borrow_input_port_by_index
,
712 get_input_port_count
,
713 bt2
.port
._UserComponentInputPort
)
715 def _add_output_port(self
, name
, user_data
=None):
716 utils
._check
_str
(name
)
717 fn
= native_bt
.self_component_filter_add_output_port
718 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
719 utils
._handle
_func
_status
(comp_status
,
720 'cannot add output port to filter component object')
722 return bt2
.port
._UserComponentOutputPort
._create
_from
_ptr
(self_port_ptr
)
724 def _add_input_port(self
, name
, user_data
=None):
725 utils
._check
_str
(name
)
726 fn
= native_bt
.self_component_filter_add_input_port
727 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
728 utils
._handle
_func
_status
(comp_status
,
729 'cannot add input port to filter component object')
731 return bt2
.port
._UserComponentInputPort
._create
_from
_ptr
(self_port_ptr
)
734 class _UserSinkComponent(_UserComponent
, _SinkComponent
):
735 _bt_as_not_self_specific_component_ptr
= staticmethod(native_bt
.self_component_sink_as_component_sink
)
736 _bt_as_self_component_ptr
= staticmethod(native_bt
.self_component_sink_as_self_component
)
739 def _input_ports(self
):
740 def get_input_port_count(self_ptr
):
741 ptr
= self
._bt
_as
_not
_self
_specific
_component
_ptr
(self_ptr
)
742 return native_bt
.component_sink_get_input_port_count(ptr
)
744 return _ComponentPorts(self
._bt
_ptr
,
745 native_bt
.self_component_sink_borrow_input_port_by_name
,
746 native_bt
.self_component_sink_borrow_input_port_by_index
,
747 get_input_port_count
,
748 bt2
.port
._UserComponentInputPort
)
750 def _add_input_port(self
, name
, user_data
=None):
751 utils
._check
_str
(name
)
752 fn
= native_bt
.self_component_sink_add_input_port
753 comp_status
, self_port_ptr
= fn(self
._bt
_ptr
, name
, user_data
)
754 utils
._handle
_func
_status
(comp_status
,
755 'cannot add input port to sink component object')
757 return bt2
.port
._UserComponentInputPort
._create
_from
_ptr
(self_port_ptr
)