class _MessageIterator(collections.abc.Iterator):
- def _handle_status(self, status, gen_error_msg):
- if status == native_bt.MESSAGE_ITERATOR_STATUS_AGAIN:
- raise bt2.TryAgain
- elif status == native_bt.MESSAGE_ITERATOR_STATUS_END:
- raise bt2.Stop
- elif status < 0:
- raise bt2.Error(gen_error_msg)
-
def __next__(self):
raise NotImplementedError
def __next__(self):
if len(self._current_msgs) == self._at:
status, msgs = self._get_msg_range(self._ptr)
- self._handle_status(status,
- 'unexpected error: cannot advance the message iterator')
+ utils._handle_func_status(status,
+ 'unexpected error: cannot advance the message iterator')
self._current_msgs = msgs
self._at = 0
return bt2.message._create_from_ptr(msg_ptr)
+ @property
+ def can_seek_beginning(self):
+ res = self._can_seek_beginning(self._ptr)
+ return res != 0
+
+ def seek_beginning(self):
+ # Forget about buffered messages, they won't be valid after seeking..
+ self._current_msgs.clear()
+ self._at = 0
+
+ status = self._seek_beginning(self._ptr)
+ utils._handle_func_status(status,
+ 'cannot seek message iterator beginning')
+
# This is created when a component wants to iterate on one of its input ports.
class _UserComponentInputPortMessageIterator(_GenericMessageIterator):
- _get_msg_range = staticmethod(native_bt.py3_self_component_port_input_get_msg_range)
+ _get_msg_range = staticmethod(native_bt.bt2_self_component_port_input_get_msg_range)
_get_ref = staticmethod(native_bt.self_component_port_input_message_iterator_get_ref)
_put_ref = staticmethod(native_bt.self_component_port_input_message_iterator_put_ref)
+ _can_seek_beginning = staticmethod(native_bt.self_component_port_input_message_iterator_can_seek_beginning)
+ _seek_beginning = staticmethod(native_bt.self_component_port_input_message_iterator_seek_beginning)
# This is created when the user wants to iterate on a component's output port,
# from outside the graph.
class _OutputPortMessageIterator(_GenericMessageIterator):
- _get_msg_range = staticmethod(native_bt.py3_port_output_get_msg_range)
+ _get_msg_range = staticmethod(native_bt.bt2_port_output_get_msg_range)
_get_ref = staticmethod(native_bt.port_output_message_iterator_get_ref)
_put_ref = staticmethod(native_bt.port_output_message_iterator_put_ref)
+ _can_seek_beginning = staticmethod(native_bt.port_output_message_iterator_can_seek_beginning)
+ _seek_beginning = staticmethod(native_bt.port_output_message_iterator_seek_beginning)
# This is extended by the user to implement component classes in Python. It
@property
def _component(self):
- return native_bt.py3_get_user_component_from_user_msg_iter(self._ptr)
+ return native_bt.bt2_get_user_component_from_user_msg_iter(self._ptr)
@property
def addr(self):
utils._check_type(msg, bt2.message._Message)
- # Release the reference to the native part.
- ptr = msg._release()
- return int(ptr)
+ # The reference we return will be given to the message array.
+ # However, the `msg` Python object may stay alive, if the user has kept
+ # a reference to it. Acquire a new reference to account for that.
+ msg._get_ref(msg._ptr)
+ return int(msg._ptr)
- # Validate that the presence or lack of presence of a
- # `default_clock_snapshot` value is valid in the context of `stream_class`.
- @staticmethod
- def _validate_default_clock_snapshot(stream_class, default_clock_snapshot):
- stream_class_has_default_clock_class = stream_class.default_clock_class is not None
-
- if stream_class_has_default_clock_class and default_clock_snapshot is None:
- raise bt2.Error(
- 'stream class has a default clock class, default_clock_snapshot should not be None')
+ @property
+ def _can_seek_beginning_from_native(self):
+ # Here, we mimic the behavior of the C API:
+ #
+ # - If the iterator has a _can_seek_beginning attribute, read it and use
+ # that result.
+ # - Otherwise, the presence or absence of a `_seek_beginning`
+ # method indicates whether the iterator can seek beginning.
+ if hasattr(self, '_can_seek_beginning'):
+ can_seek_beginning = self._can_seek_beginning
+ utils._check_bool(can_seek_beginning)
+ return can_seek_beginning
+ else:
+ return hasattr(self, '_seek_beginning')
- if not stream_class_has_default_clock_class and default_clock_snapshot is not None:
- raise bt2.Error(
- 'stream class has no default clock class, default_clock_snapshot should be None')
+ def _seek_beginning_from_native(self):
+ self._seek_beginning()
def _create_event_message(self, event_class, packet, default_clock_snapshot=None):
utils._check_type(event_class, bt2.event_class._EventClass)
utils._check_type(packet, bt2.packet._Packet)
- self._validate_default_clock_snapshot(packet.stream.cls, default_clock_snapshot)
if default_clock_snapshot is not None:
+ if event_class.stream_class.default_clock_class is None:
+ raise ValueError('event messages in this stream must not have a default clock snapshot')
+
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_event_create_with_default_clock_snapshot(
self._ptr, event_class._ptr, packet._ptr, default_clock_snapshot)
else:
+ if event_class.stream_class.default_clock_class is not None:
+ raise ValueError('event messages in this stream must have a default clock snapshot')
+
ptr = native_bt.message_event_create(
self._ptr, event_class._ptr, packet._ptr)
return bt2.message._MessageIteratorInactivityMessage(ptr)
+ _unknown_clock_snapshot = bt2.message._StreamActivityMessageUnknownClockSnapshot()
+ _infinite_clock_snapshot = bt2.message._StreamActivityMessageInfiniteClockSnapshot()
+
+ @staticmethod
+ def _validate_stream_activity_message_default_clock_snapshot(stream, default_cs):
+ isinst_infinite = isinstance(default_cs, bt2.message._StreamActivityMessageInfiniteClockSnapshot)
+ isinst_unknown = isinstance(default_cs, bt2.message._StreamActivityMessageUnknownClockSnapshot)
+
+ if utils._is_uint64(default_cs):
+ pass
+ elif isinst_infinite or isinst_unknown:
+ if default_cs is not _UserMessageIterator._unknown_clock_snapshot and default_cs is not _UserMessageIterator._infinite_clock_snapshot:
+ raise ValueError('unexpected value for default clock snapshot')
+ else:
+ raise TypeError("unexpected type '{}' for default clock snapshot".format(default_cs.__class__.__name__))
+
+ if stream.cls.default_clock_class is None:
+ if utils._is_uint64(default_cs):
+ raise ValueError('stream activity messages in this stream cannot have a known default clock snapshot')
+
def _create_stream_beginning_message(self, stream):
utils._check_type(stream, bt2.stream._Stream)
return bt2.message._StreamBeginningMessage(ptr)
- def _create_stream_activity_beginning_message(self, stream, default_clock_snapshot=None):
+ def _create_stream_activity_beginning_message(self, stream,
+ default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
- self._validate_default_clock_snapshot(stream.cls, default_clock_snapshot)
-
+ self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
ptr = native_bt.message_stream_activity_beginning_create(self._ptr, stream._ptr)
if ptr is None:
'cannot create stream activity beginning message object')
msg = bt2.message._StreamActivityBeginningMessage(ptr)
-
- if default_clock_snapshot is not None:
- msg._default_clock_snapshot = default_clock_snapshot
-
+ msg._default_clock_snapshot = default_clock_snapshot
return msg
- def _create_stream_activity_end_message(self, stream, default_clock_snapshot=None):
+ def _create_stream_activity_end_message(self, stream,
+ default_clock_snapshot=_unknown_clock_snapshot):
utils._check_type(stream, bt2.stream._Stream)
- self._validate_default_clock_snapshot(stream.cls, default_clock_snapshot)
-
+ self._validate_stream_activity_message_default_clock_snapshot(stream, default_clock_snapshot)
ptr = native_bt.message_stream_activity_end_create(self._ptr, stream._ptr)
if ptr is None:
'cannot create stream activity end message object')
msg = bt2.message._StreamActivityEndMessage(ptr)
-
- if default_clock_snapshot is not None:
- msg._default_clock_snapshot = default_clock_snapshot
-
+ msg._default_clock_snapshot = default_clock_snapshot
return msg
def _create_stream_end_message(self, stream):
if packet.stream.cls.packets_have_beginning_default_clock_snapshot:
if default_clock_snapshot is None:
- raise ValueError("packet beginning messages in this stream must have a default clock snapshots")
+ raise ValueError("packet beginning messages in this stream must have a default clock snapshot")
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot(
self._ptr, packet._ptr, default_clock_snapshot)
else:
if default_clock_snapshot is not None:
- raise ValueError("packet beginning messages in this stream must not have a default clock snapshots")
+ raise ValueError("packet beginning messages in this stream must not have a default clock snapshot")
ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr)
if packet.stream.cls.packets_have_end_default_clock_snapshot:
if default_clock_snapshot is None:
- raise ValueError("packet end messages in this stream must have a default clock snapshots")
+ raise ValueError("packet end messages in this stream must have a default clock snapshot")
utils._check_uint64(default_clock_snapshot)
ptr = native_bt.message_packet_end_create_with_default_clock_snapshot(
self._ptr, packet._ptr, default_clock_snapshot)
else:
if default_clock_snapshot is not None:
- raise ValueError("packet end messages in this stream must not have a default clock snapshots")
+ raise ValueError("packet end messages in this stream must not have a default clock snapshot")
ptr = native_bt.message_packet_end_create(self._ptr, packet._ptr)
projects / babeltrace.git / blobdiff