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