bt2: Adapt test_graph.py and make it pass
[babeltrace.git] / bindings / python / bt2 / bt2 / port.py
CommitLineData
811644b8
PP
1# The MIT License (MIT)
2#
3# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
4#
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:
11#
12# The above copyright notice and this permission notice shall be included in
13# all copies or substantial portions of the Software.
14#
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
21# THE SOFTWARE.
22
894a8df5 23from bt2 import native_bt, object
811644b8
PP
24import bt2.component
25import bt2.connection
5602ef81
SM
26import bt2.message_iterator
27import bt2.message
811644b8
PP
28import bt2
29
30
2c67587a
SM
31def _create_from_ptr_and_get_ref(ptr, port_type):
32 cls = _PORT_TYPE_TO_PYCLS.get(port_type, None)
33
34 if cls is None:
35 raise bt2.Error('unknown port type: {}'.format(port_type))
36
37 return cls._create_from_ptr_and_get_ref(ptr)
38
39
40def _create_self_from_ptr_and_get_ref(ptr, port_type):
41 cls = _PORT_TYPE_TO_USER_PYCLS.get(port_type, None)
42
43 if cls is None:
44 raise bt2.Error('unknown port type: {}'.format(port_type))
45
46 return cls._create_from_ptr_and_get_ref(ptr)
47
48
78288f58 49class _Port(object._SharedObject):
894a8df5
SM
50 @classmethod
51 def _get_ref(cls, ptr):
52 ptr = cls._as_port_ptr(ptr)
53 return native_bt.port_get_ref(ptr)
811644b8 54
894a8df5
SM
55 @classmethod
56 def _put_ref(cls, ptr):
57 ptr = cls._as_port_ptr(ptr)
58 return native_bt.port_put_ref(ptr)
811644b8
PP
59
60 @property
61 def name(self):
894a8df5
SM
62 ptr = self._as_port_ptr(self._ptr)
63 name = native_bt.port_get_name(ptr)
64 assert name is not None
65 return name
811644b8
PP
66
67 @property
68 def connection(self):
894a8df5
SM
69 ptr = self._as_port_ptr(self._ptr)
70 conn_ptr = native_bt.port_borrow_connection_const(ptr)
811644b8
PP
71
72 if conn_ptr is None:
73 return
74
894a8df5 75 return bt2.connection._Connection._create_from_ptr_and_get_ref(conn_ptr)
811644b8
PP
76
77 @property
78 def is_connected(self):
79 return self.connection is not None
80
811644b8
PP
81
82class _InputPort(_Port):
894a8df5 83 _as_port_ptr = staticmethod(native_bt.port_input_as_port_const)
811644b8
PP
84
85
86class _OutputPort(_Port):
894a8df5 87 _as_port_ptr = staticmethod(native_bt.port_output_as_port_const)
dc43190b 88
dc43190b 89
894a8df5
SM
90class _UserComponentPort(_Port):
91 @classmethod
92 def _as_port_ptr(cls, ptr):
93 ptr = cls._as_self_port_ptr(ptr)
94 return native_bt.self_component_port_as_port(ptr)
811644b8
PP
95
96 @property
97 def connection(self):
894a8df5
SM
98 ptr = self._as_port_ptr(self._ptr)
99 conn_ptr = native_bt.port_borrow_connection_const(ptr)
811644b8
PP
100
101 if conn_ptr is None:
102 return
103
894a8df5 104 return bt2.connection._Connection._create_from_ptr_and_get_ref(conn_ptr)
811644b8
PP
105
106
894a8df5
SM
107class _UserComponentInputPort(_UserComponentPort, _InputPort):
108 _as_self_port_ptr = staticmethod(native_bt.self_component_port_input_as_self_component_port)
811644b8 109
5f25509b
SM
110 def create_message_iterator(self):
111 msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create(self._ptr)
112 if msg_iter_ptr is None:
113 raise bt2.CreationError('cannot create message iterator object')
114
115 return bt2.message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr)
116
811644b8 117
894a8df5
SM
118class _UserComponentOutputPort(_UserComponentPort, _OutputPort):
119 _as_self_port_ptr = staticmethod(native_bt.self_component_port_output_as_self_component_port)
2c67587a
SM
120
121
122_PORT_TYPE_TO_PYCLS = {
123 native_bt.PORT_TYPE_INPUT: _InputPort,
124 native_bt.PORT_TYPE_OUTPUT: _OutputPort,
125}
126
127
128_PORT_TYPE_TO_USER_PYCLS = {
129 native_bt.PORT_TYPE_INPUT: _UserComponentInputPort,
130 native_bt.PORT_TYPE_OUTPUT: _UserComponentOutputPort,
131}
This page took 0.035177 seconds and 4 git commands to generate.