src/bindings/python/bt2/bt2/message.py

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