plantstar-shared 2.0.3.0.2.13__tar.gz → 2.0.3.0.2.15__tar.gz

{plantstar-shared-2.0.3.0.2.13 → plantstar-shared-2.0.3.0.2.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.13
+Version: 2.0.3.0.2.15
 Summary: Shared code used in plantstar_apu and plantstar_dcm
 Home-page: https://github.com/SYSCON-International/plantstar_shared
 Author: SYSCON International

{plantstar-shared-2.0.3.0.2.13 → plantstar-shared-2.0.3.0.2.15}/plantstar_shared/tcp_socket_utils.py

@@ -8,11 +8,11 @@ SIZE_OF_UNSIGNED_INT_FOR_HUSKY = 2  # size of the integer value that precedes da
 SIZE_OF_UNSIGNED_INT_STRUCT = 4  # size of the integer value that precedes data coming from most sockets (DeviceController, DCM, etc)
 
 
-def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes_for_size_prefix):
+def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes_for_size_prefix, size_value_includes_size_prefix_bytes=False):
     size_bytes = remote_socket.recv(number_of_bytes_for_size_prefix)
 
     if not size_bytes:
-        return None, None
+        raise SocketConnectionError
 
     if number_of_bytes_for_size_prefix == SIZE_OF_UNSIGNED_INT_FOR_HUSKY:
         size_for_message = int.from_bytes(size_bytes, 'big') if is_big_endian else int.from_bytes(size_bytes, 'little')
@@ -26,10 +26,16 @@ def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes
     else:
         raise SysconProgrammingError("A size prefix was set to something other than 2 or 4")
 
+    if size_value_includes_size_prefix_bytes:
+        size_for_message = size_for_message - number_of_bytes_for_size_prefix
+
     return size_for_message, size_bytes
 
 
-def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=0):
+def get_bytes_from_socket(
+    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=0, size_value_includes_size_prefix_bytes=False,
+    size_value_should_be_included_in_final_message=False
+):
     """Obtains a number of bytes from a provided socket, with options for different configurations and situations.
     Returns byte sequence, and the size value that was obtained from the prefix bytes.
 
@@ -38,11 +44,13 @@ def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big
 
         number_of_bytes_to_read -- the number of bytes to read on the socket, if this is known, this is the only optional parameter needed (default: 0)
 
-        is_big_endian -- bool that determines what format string should be used for unpacking the size value (default: True)
+        is_big_endian -- bool: what format string should be used for unpacking the size value (default: True)
 
         number_of_bytes_for_size_prefix -- the number of bytes to read to determine the total size of the message to pass (default: 0)
 
-        should_remove_prefix_size_from_read -- bool that determines if the size should be removed from the calculated number of bytes to read (default: False)
+        size_value_includes_size_prefix_bytes -- bool: if size value includes the size_prefix_bytes based on the systems implementation
+
+        size_value_should_be_included_in_final_message  -- bool: if size value should be prepended to the byte sequence, likely only Husky logic wants this (default: False)
 
         -----
 
@@ -55,18 +63,24 @@ def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big
 
     """
 
+    packets = []
+
     if not number_of_bytes_to_read:
         if number_of_bytes_for_size_prefix:
             number_of_bytes_to_read, size_bytes = read_size_value_from_socket(
-                remote_socket=remote_socket, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix
+                remote_socket=remote_socket, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix,
+                size_value_includes_size_prefix_bytes=size_value_includes_size_prefix_bytes
             )
 
             if not number_of_bytes_to_read:
-                return None, None
+                raise SocketConnectionError
+
+            if size_value_should_be_included_in_final_message:
+                packets.append(size_bytes)
+
         else:
             raise SysconProgrammingError("get_bytes_from_socket was called with no parameters for number_of_bytes_to_read or number_of_bytes_for_size_prefix")
 
-    packets = []
     bytes_received = 0
 
     # While loop that will stream in data if the full request is not available yet
@@ -75,7 +89,7 @@ def get_bytes_from_socket(*, remote_socket, number_of_bytes_to_read=None, is_big
         packet = remote_socket.recv(buffer_size)
 
         if not packet:
-            return None, number_of_bytes_to_read
+            raise SocketConnectionError
 
         packets.append(packet)
         bytes_received = bytes_received + len(packet)
@@ -102,15 +116,17 @@ def send_encoded_message_on_socket(*, remote_socket, encoded_message):
 
 
 def get_object_from_socket(
-    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=SIZE_OF_UNSIGNED_INT_STRUCT
+    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=SIZE_OF_UNSIGNED_INT_STRUCT,
+    size_value_includes_size_prefix_bytes=False
 ):
     """Function that is used between the APU and DCM to send dictionaries. Returns a tuple of the object and its size in bytes."""
     object_from_interface_as_bytes, size_of_object_in_bytes = get_bytes_from_socket(
-        remote_socket=remote_socket, number_of_bytes_to_read=number_of_bytes_to_read, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix
+        remote_socket=remote_socket, number_of_bytes_to_read=number_of_bytes_to_read, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix,
+        size_value_includes_size_prefix_bytes=size_value_includes_size_prefix_bytes
     )
 
     if not object_from_interface_as_bytes:
-        return None, None
+        raise SocketConnectionError
 
     object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
     return object_from_interface, size_of_object_in_bytes

{plantstar-shared-2.0.3.0.2.13 → plantstar-shared-2.0.3.0.2.15}/plantstar_shared.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.13
+Version: 2.0.3.0.2.15
 Summary: Shared code used in plantstar_apu and plantstar_dcm
 Home-page: https://github.com/SYSCON-International/plantstar_shared
 Author: SYSCON International

{plantstar-shared-2.0.3.0.2.13 → plantstar-shared-2.0.3.0.2.15}/setup.py

@@ -7,7 +7,7 @@ setuptools.setup(
     name="plantstar-shared",
     # MAJOR_MILESTONE_VERSION.MINOR_MILESTONE_VERSION.MAJOR_VERSION.MINOR_VERSION.HOTFIX_VERSION.SUBVERSION
     # The main version should stay as v2.0.3.0.x until we have passed that in the plantstar_apu/plantstar_dcm projects
-    version="2.0.3.0.2.13",
+    version="2.0.3.0.2.15",
     author="SYSCON International",
     author_email="dev@syscon-intl.com",
     description="Shared code used in plantstar_apu and plantstar_dcm",