class _MessageIterator(collections.abc.Iterator):
def _handle_status(self, status, gen_error_msg):
- if status == native_bt.MESSAGE_ITERATOR_STATUS_CANCELED:
- raise bt2.MessageIteratorCanceled
- elif status == native_bt.MESSAGE_ITERATOR_STATUS_AGAIN:
+ if status == native_bt.MESSAGE_ITERATOR_STATUS_AGAIN:
raise bt2.TryAgain
elif status == native_bt.MESSAGE_ITERATOR_STATUS_END:
raise bt2.Stop
- elif status == native_bt.MESSAGE_ITERATOR_STATUS_UNSUPPORTED:
- raise bt2.UnsupportedFeature
elif status < 0:
raise bt2.Error(gen_error_msg)
raise NotImplementedError
-class _GenericMessageIterator(object._Object, _MessageIterator):
- def _get_msg(self):
- msg_ptr = native_bt.message_iterator_get_message(self._ptr)
- utils._handle_ptr(msg_ptr, "cannot get message iterator object's current message object")
- return bt2.message._create_from_ptr(msg_ptr)
-
- def _next(self):
- status = native_bt.message_iterator_next(self._ptr)
- self._handle_status(status,
- 'unexpected error: cannot advance the message iterator')
+class _GenericMessageIterator(object._SharedObject, _MessageIterator):
+ def __init__(self, ptr):
+ self._current_msgs = []
+ self._at = 0
+ super().__init__(ptr)
def __next__(self):
- self._next()
- return self._get_msg()
+ 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')
+ self._current_msgs = msgs
+ self._at = 0
+ msg_ptr = self._current_msgs[self._at]
+ self._at += 1
-class _PrivateConnectionMessageIterator(_GenericMessageIterator):
- @property
- def component(self):
- comp_ptr = native_bt.private_connection_message_iterator_get_component(self._ptr)
- assert(comp_ptr)
- return bt2.component._create_generic_component_from_ptr(comp_ptr)
+ return bt2.message._create_from_ptr(msg_ptr)
+# 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_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)
+
+
+# This is created when the user wants to iterate on a component's output port,
+# from outside the graph.
class _OutputPortMessageIterator(_GenericMessageIterator):
- pass
+ _get_msg_range = staticmethod(native_bt.py3_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)
+# This is extended by the user to implement component classes in Python. It
+# is created for a given output port when an input port message iterator is
+# created on the input port on the other side of the connection. It is also
+# created when an output port message iterator is created on this output port.
+#
+# Its purpose is to feed the messages that should go out through this output
+# port.
class _UserMessageIterator(_MessageIterator):
def __new__(cls, ptr):
# User iterator objects are always created by the native side,
self._ptr = ptr
return self
- def __init__(self):
+ def _init_from_native(self, self_output_port_ptr):
+ self_output_port = bt2.port._create_self_from_ptr_and_get_ref(
+ self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT)
+ self.__init__(self_output_port)
+
+ def __init__(self, output_port):
pass
@property
utils._check_type(msg, bt2.message._Message)
- # take a new reference for the native part
- msg._get()
- return int(msg._ptr)
+ # Release the reference to the native part.
+ ptr = msg._release()
+ return int(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')
+
+ 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 _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.stream_class, default_clock_snapshot)
+
+ if default_clock_snapshot is not None:
+ 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:
+ ptr = native_bt.message_event_create(
+ self._ptr, event_class._ptr, packet._ptr)
+
+ if ptr is None:
+ raise bt2.CreationError('cannot create event message object')
+
+ return bt2.message._EventMessage(ptr)
+
+ def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot):
+ utils._check_type(clock_class, bt2.clock_class._ClockClass)
+ ptr = native_bt.message_message_iterator_inactivity_create(
+ self._ptr, clock_class._ptr, clock_snapshot)
+
+ if ptr is None:
+ raise bt2.CreationError('cannot create inactivity message object')
+
+ return bt2.message._MessageIteratorInactivityMessage(ptr)
+
+ def _create_stream_beginning_message(self, stream):
+ utils._check_type(stream, bt2.stream._Stream)
+
+ ptr = native_bt.message_stream_beginning_create(self._ptr, stream._ptr)
+ if ptr is None:
+ raise bt2.CreationError('cannot create stream beginning message object')
+
+ return bt2.message._StreamBeginningMessage(ptr)
+
+ def _create_stream_activity_beginning_message(self, stream, default_clock_snapshot=None):
+ utils._check_type(stream, bt2.stream._Stream)
+ self._validate_default_clock_snapshot(stream.stream_class, default_clock_snapshot)
+
+ ptr = native_bt.message_stream_activity_beginning_create(self._ptr, stream._ptr)
+
+ if ptr is None:
+ raise bt2.CreationError(
+ '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
+
+ return msg
+
+ def _create_stream_activity_end_message(self, stream, default_clock_snapshot=None):
+ utils._check_type(stream, bt2.stream._Stream)
+ self._validate_default_clock_snapshot(stream.stream_class, default_clock_snapshot)
+
+ ptr = native_bt.message_stream_activity_end_create(self._ptr, stream._ptr)
+
+ if ptr is None:
+ raise bt2.CreationError(
+ '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
+
+ return msg
+
+ def _create_stream_end_message(self, stream):
+ utils._check_type(stream, bt2.stream._Stream)
+
+ ptr = native_bt.message_stream_end_create(self._ptr, stream._ptr)
+ if ptr is None:
+ raise bt2.CreationError('cannot create stream end message object')
+
+ return bt2.message._StreamEndMessage(ptr)
+
+ def _create_packet_beginning_message(self, packet, default_clock_snapshot=None):
+ utils._check_type(packet, bt2.packet._Packet)
+
+ if packet.stream.stream_class.packets_have_default_beginning_clock_snapshot:
+ if default_clock_snapshot is None:
+ raise ValueError("packet beginning messages in this stream must have a default clock snapshots")
+
+ 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")
+
+ ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr)
+
+ if ptr is None:
+ raise bt2.CreationError('cannot create packet beginning message object')
+
+ return bt2.message._PacketBeginningMessage(ptr)
+
+ def _create_packet_end_message(self, packet, default_clock_snapshot=None):
+ utils._check_type(packet, bt2.packet._Packet)
+
+ if packet.stream.stream_class.packets_have_default_end_clock_snapshot:
+ if default_clock_snapshot is None:
+ raise ValueError("packet end messages in this stream must have a default clock snapshots")
+
+ 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")
+
+ ptr = native_bt.message_packet_end_create(self._ptr, packet._ptr)
+
+ if ptr is None:
+ raise bt2.CreationError('cannot create packet end message object')
+
+ return bt2.message._PacketEndMessage(ptr)
+
+ def _create_discarded_events_message(self, stream, count=None,
+ beg_clock_snapshot=None,
+ end_clock_snapshot=None):
+ utils._check_type(stream, bt2.stream._Stream)
+
+ if beg_clock_snapshot is None and end_clock_snapshot is None:
+ ptr = native_bt.message_discarded_events_create(self._ptr, stream._ptr)
+ elif beg_clock_snapshot is not None and end_clock_snapshot is not None:
+ utils._check_uint64(beg_clock_snapshot)
+ utils._check_uint64(end_clock_snapshot)
+ ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots(
+ self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
+ else:
+ raise ValueError('begin and end clock snapshots must be both provided or both omitted')
+
+ if ptr is None:
+ raise bt2.CreationError('cannot discarded events message object')
+
+ msg = bt2.message._DiscardedEventsMessage(ptr)
+
+ if count is not None:
+ msg._count = count
+
+ return msg
+
+ def _create_discarded_packets_message(self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None):
+ utils._check_type(stream, bt2.stream._Stream)
+
+ if beg_clock_snapshot is None and end_clock_snapshot is None:
+ ptr = native_bt.message_discarded_packets_create(self._ptr, stream._ptr)
+ elif beg_clock_snapshot is not None and end_clock_snapshot is not None:
+ utils._check_uint64(beg_clock_snapshot)
+ utils._check_uint64(end_clock_snapshot)
+ ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots(
+ self._ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot)
+ else:
+ raise ValueError('begin and end clock snapshots must be both provided or both omitted')
+
+ if ptr is None:
+ raise bt2.CreationError('cannot discarded packets message object')
+
+ msg = bt2.message._DiscardedPacketsMessage(ptr)
+
+ if count is not None:
+ msg._count = count
+
+ return msg
+
projects / babeltrace.git / blobdiff