Commit | Line | Data |
---|---|---|
81447b5b 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 | ||
23 | from bt2 import native_bt, object, utils | |
f192fc47 | 24 | import bt2.clock_snapshot |
81447b5b PP |
25 | import bt2.packet |
26 | import bt2.stream | |
27 | import bt2.event | |
28 | import bt2 | |
29 | ||
30 | ||
31 | def _create_from_ptr(ptr): | |
fa4c33e3 | 32 | msg_type = native_bt.message_get_type(ptr) |
81447b5b | 33 | |
fa4c33e3 SM |
34 | if msg_type not in _MESSAGE_TYPE_TO_CLS: |
35 | raise bt2.Error('unknown message type: {}'.format(msg_type)) | |
81447b5b | 36 | |
fa4c33e3 | 37 | return _MESSAGE_TYPE_TO_CLS[msg_type]._create_from_ptr(ptr) |
81447b5b PP |
38 | |
39 | ||
c3044a97 | 40 | class _Message(object._SharedObject): |
27d97a3f SM |
41 | _get_ref = staticmethod(native_bt.message_get_ref) |
42 | _put_ref = staticmethod(native_bt.message_put_ref) | |
81447b5b | 43 | |
77037b2b PP |
44 | @staticmethod |
45 | def _check_has_default_clock_class(clock_class): | |
46 | if clock_class is None: | |
47 | raise bt2.NonexistentClockSnapshot('cannot get default clock snapshot: stream class has no default clock class') | |
48 | ||
81447b5b | 49 | |
0010c8b0 SM |
50 | class _MessageWithDefaultClockSnapshot: |
51 | def _get_default_clock_snapshot(self, borrow_clock_snapshot_ptr): | |
0010c8b0 | 52 | snapshot_ptr = borrow_clock_snapshot_ptr(self._ptr) |
f6a5e476 | 53 | |
0010c8b0 SM |
54 | return bt2.clock_snapshot._ClockSnapshot._create_from_ptr_and_get_ref( |
55 | snapshot_ptr, self._ptr, self._get_ref, self._put_ref) | |
f6a5e476 | 56 | |
0010c8b0 SM |
57 | |
58 | class _EventMessage(_Message, _MessageWithDefaultClockSnapshot): | |
59 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_event_borrow_default_clock_snapshot_const) | |
60 | ||
0010c8b0 SM |
61 | @property |
62 | def default_clock_snapshot(self): | |
77037b2b | 63 | self._check_has_default_clock_class(self.event.packet.stream.stream_class.default_clock_class) |
0010c8b0 | 64 | return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr) |
f6a5e476 | 65 | |
27d97a3f SM |
66 | @property |
67 | def event(self): | |
68 | event_ptr = native_bt.message_event_borrow_event(self._ptr) | |
69 | assert event_ptr is not None | |
70 | return bt2.event._Event._create_from_ptr_and_get_ref( | |
71 | event_ptr, self._ptr, self._get_ref, self._put_ref) | |
81447b5b | 72 | |
81447b5b | 73 | |
0010c8b0 | 74 | class _PacketMessage(_Message, _MessageWithDefaultClockSnapshot): |
81447b5b | 75 | @property |
0010c8b0 | 76 | def default_clock_snapshot(self): |
77037b2b | 77 | self._check_has_default_clock_class(self.packet.stream.stream_class.default_clock_class) |
0010c8b0 | 78 | return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr) |
81447b5b | 79 | |
81447b5b PP |
80 | @property |
81 | def packet(self): | |
0010c8b0 SM |
82 | packet_ptr = self._borrow_packet_ptr(self._ptr) |
83 | assert packet_ptr is not None | |
84 | return bt2.packet._Packet._create_from_ptr_and_get_ref(packet_ptr) | |
f6a5e476 | 85 | |
f6a5e476 | 86 | |
0010c8b0 SM |
87 | class _PacketBeginningMessage(_PacketMessage): |
88 | _borrow_packet_ptr = staticmethod(native_bt.message_packet_beginning_borrow_packet) | |
89 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_packet_beginning_borrow_default_clock_snapshot_const) | |
f6a5e476 | 90 | |
f6a5e476 | 91 | |
0010c8b0 SM |
92 | class _PacketEndMessage(_PacketMessage): |
93 | _borrow_packet_ptr = staticmethod(native_bt.message_packet_end_borrow_packet) | |
94 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_packet_end_borrow_default_clock_snapshot_const) | |
f6a5e476 | 95 | |
81447b5b | 96 | |
0010c8b0 | 97 | class _StreamMessage(_Message): |
81447b5b PP |
98 | @property |
99 | def stream(self): | |
0010c8b0 SM |
100 | stream_ptr = self._borrow_stream_ptr(self._ptr) |
101 | assert stream_ptr | |
102 | return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr) | |
f6a5e476 | 103 | |
f6a5e476 | 104 | |
0010c8b0 SM |
105 | class _StreamBeginningMessage(_StreamMessage): |
106 | _borrow_stream_ptr = staticmethod(native_bt.message_stream_beginning_borrow_stream) | |
f6a5e476 | 107 | |
f6a5e476 | 108 | |
0010c8b0 SM |
109 | class _StreamEndMessage(_StreamMessage): |
110 | _borrow_stream_ptr = staticmethod(native_bt.message_stream_end_borrow_stream) | |
f6a5e476 | 111 | |
81447b5b | 112 | |
0010c8b0 | 113 | class _StreamActivityMessage(_Message): |
81447b5b | 114 | @property |
0010c8b0 | 115 | def default_clock_snapshot(self): |
77037b2b | 116 | self._check_has_default_clock_class(self.stream.stream_class.default_clock_class) |
0010c8b0 | 117 | status, snapshot_ptr = self._borrow_default_clock_snapshot_ptr(self._ptr) |
81447b5b | 118 | |
0010c8b0 SM |
119 | if status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN: |
120 | snapshot_type = bt2.clock_snapshot._ClockSnapshot | |
121 | elif status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN: | |
122 | snapshot_type = bt2.clock_snapshot._UnknownClockSnapshot | |
123 | elif status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE: | |
124 | snapshot_type = bt2.clock_snapshot._InfiniteClockSnapshot | |
f6a5e476 | 125 | else: |
0010c8b0 | 126 | raise bt2.Error('cannot borrow default clock snapshot from message') |
81447b5b | 127 | |
0010c8b0 | 128 | assert snapshot_ptr is not None |
81447b5b | 129 | |
0010c8b0 SM |
130 | return snapshot_type._create_from_ptr_and_get_ref( |
131 | snapshot_ptr, self._ptr, self._get_ref, self._put_ref) | |
81447b5b | 132 | |
0010c8b0 SM |
133 | def _default_clock_snapshot(self, value): |
134 | self._set_default_clock_snapshot_ptr(self._ptr, value) | |
81447b5b | 135 | |
0010c8b0 | 136 | _default_clock_snapshot = property(fset=_default_clock_snapshot) |
f6a5e476 | 137 | |
8ae92ae2 | 138 | @property |
0010c8b0 SM |
139 | def stream(self): |
140 | stream_ptr = self._borrow_stream_ptr(self._ptr) | |
141 | assert stream_ptr | |
142 | return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr) | |
f6a5e476 PP |
143 | |
144 | ||
0010c8b0 SM |
145 | class _StreamActivityBeginningMessage(_StreamActivityMessage): |
146 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_beginning_borrow_default_clock_snapshot_const) | |
147 | _set_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_beginning_set_default_clock_snapshot) | |
148 | _borrow_stream_ptr = staticmethod(native_bt.message_stream_activity_beginning_borrow_stream) | |
f6a5e476 | 149 | |
f6a5e476 | 150 | |
0010c8b0 SM |
151 | class _StreamActivityEndMessage(_StreamActivityMessage): |
152 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_end_borrow_default_clock_snapshot_const) | |
153 | _set_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_end_set_default_clock_snapshot) | |
154 | _borrow_stream_ptr = staticmethod(native_bt.message_stream_activity_end_borrow_stream) | |
f6a5e476 PP |
155 | |
156 | ||
0010c8b0 | 157 | class _MessageIteratorInactivityMessage(_Message, _MessageWithDefaultClockSnapshot): |
0010c8b0 | 158 | _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_message_iterator_inactivity_borrow_default_clock_snapshot_const) |
f6a5e476 PP |
159 | |
160 | @property | |
0010c8b0 | 161 | def default_clock_snapshot(self): |
77037b2b PP |
162 | # This kind of message always has a default clock class: no |
163 | # need to call self._check_has_default_clock_class() here. | |
0010c8b0 SM |
164 | return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr) |
165 | ||
f6a5e476 | 166 | |
0010c8b0 | 167 | class _DiscardedMessage(_Message, _MessageWithDefaultClockSnapshot): |
f6a5e476 PP |
168 | @property |
169 | def stream(self): | |
0010c8b0 SM |
170 | stream_ptr = self._borrow_stream_ptr(self._ptr) |
171 | assert stream_ptr | |
172 | return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr) | |
f6a5e476 | 173 | |
f6a5e476 PP |
174 | @property |
175 | def count(self): | |
0010c8b0 SM |
176 | avail, count = self._get_count(self._ptr) |
177 | if avail is native_bt.PROPERTY_AVAILABILITY_AVAILABLE: | |
178 | return count | |
f6a5e476 | 179 | |
0010c8b0 SM |
180 | def _set_count(self, count): |
181 | utils._check_uint64(count) | |
182 | self._set_count(self._ptr, count) | |
183 | ||
184 | _count = property(fset=_set_count) | |
f6a5e476 | 185 | |
77037b2b PP |
186 | def _check_has_default_clock_snapshots(self): |
187 | if not self._has_default_clock_snapshots: | |
188 | raise bt2.NonexistentClockSnapshot('cannot get default clock snapshot: such a message has no clock snapshots for this stream class') | |
189 | ||
f6a5e476 | 190 | @property |
0010c8b0 | 191 | def beginning_default_clock_snapshot(self): |
77037b2b | 192 | self._check_has_default_clock_snapshots() |
0010c8b0 | 193 | return self._get_default_clock_snapshot(self._borrow_beginning_clock_snapshot_ptr) |
f6a5e476 | 194 | |
0010c8b0 SM |
195 | @property |
196 | def end_default_clock_snapshot(self): | |
77037b2b | 197 | self._check_has_default_clock_snapshots() |
0010c8b0 | 198 | return self._get_default_clock_snapshot(self._borrow_end_clock_snapshot_ptr) |
f6a5e476 | 199 | |
f6a5e476 | 200 | |
0010c8b0 SM |
201 | class _DiscardedEventsMessage(_DiscardedMessage): |
202 | _borrow_stream_ptr = staticmethod(native_bt.message_discarded_events_borrow_stream_const) | |
203 | _get_count = staticmethod(native_bt.message_discarded_events_get_count) | |
204 | _set_count = staticmethod(native_bt.message_discarded_events_set_count) | |
5ef34326 PP |
205 | _borrow_beginning_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_events_borrow_beginning_default_clock_snapshot_const) |
206 | _borrow_end_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_events_borrow_end_default_clock_snapshot_const) | |
f6a5e476 | 207 | |
77037b2b PP |
208 | @property |
209 | def _has_default_clock_snapshots(self): | |
210 | return self.stream.stream_class.discarded_events_have_default_clock_snapshots | |
211 | ||
f6a5e476 | 212 | |
0010c8b0 SM |
213 | class _DiscardedPacketsMessage(_DiscardedMessage): |
214 | _borrow_stream_ptr = staticmethod(native_bt.message_discarded_packets_borrow_stream_const) | |
215 | _get_count = staticmethod(native_bt.message_discarded_packets_get_count) | |
216 | _set_count = staticmethod(native_bt.message_discarded_packets_set_count) | |
5ef34326 PP |
217 | _borrow_beginning_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_packets_borrow_beginning_default_clock_snapshot_const) |
218 | _borrow_end_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_packets_borrow_end_default_clock_snapshot_const) | |
81447b5b | 219 | |
77037b2b PP |
220 | @property |
221 | def _has_default_clock_snapshots(self): | |
222 | return self.stream.stream_class.discarded_packets_have_default_clock_snapshots | |
223 | ||
81447b5b | 224 | |
fa4c33e3 | 225 | _MESSAGE_TYPE_TO_CLS = { |
27d97a3f | 226 | native_bt.MESSAGE_TYPE_EVENT: _EventMessage, |
0010c8b0 | 227 | native_bt.MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: _MessageIteratorInactivityMessage, |
27d97a3f | 228 | native_bt.MESSAGE_TYPE_STREAM_BEGINNING: _StreamBeginningMessage, |
871a292a | 229 | native_bt.MESSAGE_TYPE_STREAM_END: _StreamEndMessage, |
0010c8b0 SM |
230 | native_bt.MESSAGE_TYPE_PACKET_BEGINNING: _PacketBeginningMessage, |
231 | native_bt.MESSAGE_TYPE_PACKET_END: _PacketEndMessage, | |
232 | native_bt.MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: _StreamActivityBeginningMessage, | |
233 | native_bt.MESSAGE_TYPE_STREAM_ACTIVITY_END: _StreamActivityEndMessage, | |
fa4c33e3 | 234 | native_bt.MESSAGE_TYPE_DISCARDED_EVENTS: _DiscardedEventsMessage, |
0010c8b0 | 235 | native_bt.MESSAGE_TYPE_DISCARDED_PACKETS: _DiscardedPacketsMessage, |
81447b5b | 236 | } |