bt2: Adapt test_message_iterator.py and make it pass
[babeltrace.git] / bindings / python / bt2 / bt2 / message_iterator.py
index 781c876d86e9ae3081b9e6bbbd3cd906ae09de2f..7ac98f3dfcf64c35792972ae675c9a7695c757c6 100644 (file)
@@ -60,22 +60,28 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator):
         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)
-
-    @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)
+    _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):
     _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,
@@ -92,7 +98,12 @@ class _UserMessageIterator(_MessageIterator):
         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
@@ -156,6 +167,16 @@ class _UserMessageIterator(_MessageIterator):
 
         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)
 
@@ -165,6 +186,40 @@ class _UserMessageIterator(_MessageIterator):
 
         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)
 
@@ -179,14 +234,14 @@ class _UserMessageIterator(_MessageIterator):
 
         if packet.stream.stream_class.packets_have_default_beginning_clock_snapshot:
             if default_clock_snapshot is None:
-                raise bt2.CreationError("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 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 bt2.CreationError("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 snapshots")
 
             ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr)
 
@@ -197,16 +252,70 @@ class _UserMessageIterator(_MessageIterator):
 
     def _create_packet_end_message(self, packet, default_clock_snapshot=None):
         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:
+        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
+
This page took 0.024572 seconds and 4 git commands to generate.