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
.clock_snapshot
31 def _create_from_ptr(ptr
):
32 msg_type
= native_bt
.message_get_type(ptr
)
34 if msg_type
not in _MESSAGE_TYPE_TO_CLS
:
35 raise bt2
.Error('unknown message type: {}'.format(msg_type
))
37 return _MESSAGE_TYPE_TO_CLS
[msg_type
]._create
_from
_ptr
(ptr
)
40 class _Message(object._SharedObject
):
41 _get_ref
= staticmethod(native_bt
.message_get_ref
)
42 _put_ref
= staticmethod(native_bt
.message_put_ref
)
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')
50 class _MessageWithDefaultClockSnapshot
:
51 def _get_default_clock_snapshot(self
, borrow_clock_snapshot_ptr
):
52 snapshot_ptr
= borrow_clock_snapshot_ptr(self
._ptr
)
54 return bt2
.clock_snapshot
._ClockSnapshot
._create
_from
_ptr
_and
_get
_ref
(
55 snapshot_ptr
, self
._ptr
, self
._get
_ref
, self
._put
_ref
)
58 class _EventMessage(_Message
, _MessageWithDefaultClockSnapshot
):
59 _borrow_default_clock_snapshot_ptr
= staticmethod(native_bt
.message_event_borrow_default_clock_snapshot_const
)
62 def default_clock_snapshot(self
):
63 self
._check
_has
_default
_clock
_class
(self
.event
.stream
.cls
.default_clock_class
)
64 return self
._get
_default
_clock
_snapshot
(self
._borrow
_default
_clock
_snapshot
_ptr
)
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
)
74 class _PacketMessage(_Message
, _MessageWithDefaultClockSnapshot
):
76 def default_clock_snapshot(self
):
77 self
._check
_has
_default
_clock
_class
(self
.packet
.stream
.cls
.default_clock_class
)
78 return self
._get
_default
_clock
_snapshot
(self
._borrow
_default
_clock
_snapshot
_ptr
)
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
)
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
)
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
)
97 class _StreamMessage(_Message
, _MessageWithDefaultClockSnapshot
):
100 stream_ptr
= self
._borrow
_stream
_ptr
(self
._ptr
)
102 return bt2
.stream
._Stream
._create
_from
_ptr
_and
_get
_ref
(stream_ptr
)
105 def default_clock_snapshot(self
):
106 self
._check
_has
_default
_clock
_class
(self
.stream
.cls
.default_clock_class
)
108 status
, snapshot_ptr
= self
._borrow
_default
_clock
_snapshot
_ptr
(self
._ptr
)
110 if status
== native_bt
.MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
111 return bt2
.clock_snapshot
._UnknownClockSnapshot
()
113 return bt2
.clock_snapshot
._ClockSnapshot
._create
_from
_ptr
_and
_get
_ref
(
114 snapshot_ptr
, self
._ptr
, self
._get
_ref
, self
._put
_ref
)
116 def _default_clock_snapshot(self
, raw_value
):
117 utils
._check
_uint
64(raw_value
)
118 self
._set
_default
_clock
_snapshot
(self
._ptr
, raw_value
)
120 _default_clock_snapshot
= property(fset
=_default_clock_snapshot
)
123 class _StreamBeginningMessage(_StreamMessage
):
124 _borrow_stream_ptr
= staticmethod(native_bt
.message_stream_beginning_borrow_stream
)
125 _borrow_default_clock_snapshot_ptr
= staticmethod(native_bt
.message_stream_beginning_borrow_default_clock_snapshot_const
)
126 _set_default_clock_snapshot
= staticmethod(native_bt
.message_stream_beginning_set_default_clock_snapshot
)
129 class _StreamEndMessage(_StreamMessage
):
130 _borrow_stream_ptr
= staticmethod(native_bt
.message_stream_end_borrow_stream
)
131 _borrow_default_clock_snapshot_ptr
= staticmethod(native_bt
.message_stream_end_borrow_default_clock_snapshot_const
)
132 _set_default_clock_snapshot
= staticmethod(native_bt
.message_stream_end_set_default_clock_snapshot
)
135 class _MessageIteratorInactivityMessage(_Message
, _MessageWithDefaultClockSnapshot
):
136 _borrow_default_clock_snapshot_ptr
= staticmethod(native_bt
.message_message_iterator_inactivity_borrow_default_clock_snapshot_const
)
139 def default_clock_snapshot(self
):
140 # This kind of message always has a default clock class: no
141 # need to call self._check_has_default_clock_class() here.
142 return self
._get
_default
_clock
_snapshot
(self
._borrow
_default
_clock
_snapshot
_ptr
)
145 class _DiscardedMessage(_Message
, _MessageWithDefaultClockSnapshot
):
148 stream_ptr
= self
._borrow
_stream
_ptr
(self
._ptr
)
150 return bt2
.stream
._Stream
._create
_from
_ptr
_and
_get
_ref
(stream_ptr
)
154 avail
, count
= self
._get
_count
(self
._ptr
)
155 if avail
is native_bt
.PROPERTY_AVAILABILITY_AVAILABLE
:
158 def _set_count(self
, count
):
159 utils
._check
_uint
64(count
)
160 self
._set
_count
(self
._ptr
, count
)
162 _count
= property(fset
=_set_count
)
164 def _check_has_default_clock_snapshots(self
):
165 if not self
._has
_default
_clock
_snapshots
:
166 raise bt2
.NonexistentClockSnapshot('cannot get default clock snapshot: such a message has no clock snapshots for this stream class')
169 def beginning_default_clock_snapshot(self
):
170 self
._check
_has
_default
_clock
_snapshots
()
171 return self
._get
_default
_clock
_snapshot
(self
._borrow
_beginning
_clock
_snapshot
_ptr
)
174 def end_default_clock_snapshot(self
):
175 self
._check
_has
_default
_clock
_snapshots
()
176 return self
._get
_default
_clock
_snapshot
(self
._borrow
_end
_clock
_snapshot
_ptr
)
179 class _DiscardedEventsMessage(_DiscardedMessage
):
180 _borrow_stream_ptr
= staticmethod(native_bt
.message_discarded_events_borrow_stream_const
)
181 _get_count
= staticmethod(native_bt
.message_discarded_events_get_count
)
182 _set_count
= staticmethod(native_bt
.message_discarded_events_set_count
)
183 _borrow_beginning_clock_snapshot_ptr
= staticmethod(native_bt
.message_discarded_events_borrow_beginning_default_clock_snapshot_const
)
184 _borrow_end_clock_snapshot_ptr
= staticmethod(native_bt
.message_discarded_events_borrow_end_default_clock_snapshot_const
)
187 def _has_default_clock_snapshots(self
):
188 return self
.stream
.cls
.discarded_events_have_default_clock_snapshots
191 class _DiscardedPacketsMessage(_DiscardedMessage
):
192 _borrow_stream_ptr
= staticmethod(native_bt
.message_discarded_packets_borrow_stream_const
)
193 _get_count
= staticmethod(native_bt
.message_discarded_packets_get_count
)
194 _set_count
= staticmethod(native_bt
.message_discarded_packets_set_count
)
195 _borrow_beginning_clock_snapshot_ptr
= staticmethod(native_bt
.message_discarded_packets_borrow_beginning_default_clock_snapshot_const
)
196 _borrow_end_clock_snapshot_ptr
= staticmethod(native_bt
.message_discarded_packets_borrow_end_default_clock_snapshot_const
)
199 def _has_default_clock_snapshots(self
):
200 return self
.stream
.cls
.discarded_packets_have_default_clock_snapshots
203 _MESSAGE_TYPE_TO_CLS
= {
204 native_bt
.MESSAGE_TYPE_EVENT
: _EventMessage
,
205 native_bt
.MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
: _MessageIteratorInactivityMessage
,
206 native_bt
.MESSAGE_TYPE_STREAM_BEGINNING
: _StreamBeginningMessage
,
207 native_bt
.MESSAGE_TYPE_STREAM_END
: _StreamEndMessage
,
208 native_bt
.MESSAGE_TYPE_PACKET_BEGINNING
: _PacketBeginningMessage
,
209 native_bt
.MESSAGE_TYPE_PACKET_END
: _PacketEndMessage
,
210 native_bt
.MESSAGE_TYPE_DISCARDED_EVENTS
: _DiscardedEventsMessage
,
211 native_bt
.MESSAGE_TYPE_DISCARDED_PACKETS
: _DiscardedPacketsMessage
,