dsmq 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

dsmq/dsmq.py

@@ -5,26 +5,25 @@ import sys
 from threading import Thread
 import time
 
-DEFAULT_HOST = "127.0.0.1"
-DEFAULT_PORT = 30008
+_default_host = "127.0.0.1"
+_default_port = 30008
 
-N_RETRIES = 5
-FIRST_RETRY = 0.01  # seconds
-TIME_TO_LIVE = 60  # seconds
-TIME_TO_LIVE = 5  # seconds
+_message_length_offset = 1_000_000
+_header_length = 23
+_n_retries = 5
+_first_retry = 0.01  # seconds
+_time_to_live = 600.0  # seconds
 
 
-def start_server(host=DEFAULT_HOST, port=DEFAULT_PORT):
+def start_server(host=_default_host, port=_default_port):
     """
     For best results, start this running in its own process and walk away.
-
-
     """
     sqlite_conn = sqlite3.connect("file:mem1?mode=memory&cache=shared")
     cursor = sqlite_conn.cursor()
 
     cursor.execute("""
-        CREATE TABLE IF NOT EXISTS messages (timestamp DOUBLE, topic TEXT, message TEXT)
+CREATE TABLE IF NOT EXISTS messages (timestamp DOUBLE, topic TEXT, message TEXT)
     """)
 
     with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
@@ -49,7 +48,7 @@ def start_server(host=DEFAULT_HOST, port=DEFAULT_PORT):
     sqlite_conn.close()
 
 
-def connect_to_server(host=DEFAULT_HOST, port=DEFAULT_PORT):
+def connect_to_server(host=_default_host, port=_default_port):
     return DSMQClientSideConnection(host, port)
 
 
@@ -59,22 +58,55 @@ class DSMQClientSideConnection:
         self.dsmq_conn.connect((host, port))
 
     def get(self, topic):
-        msg = json.dumps({"action": "get", "topic": topic})
-        self.dsmq_conn.sendall(bytes(msg, "utf-8"))
+        msg_dict = {"action": "get", "topic": topic}
+        _send_message(self.dsmq_conn, msg_dict)
 
-        data = self.dsmq_conn.recv(1024)
-        if not data:
+        msg = _receive_message(self.dsmq_conn)
+        if msg is None:
             raise RuntimeError("Connection terminated by server")
-        msg_str = data.decode("utf-8")
-        msg = json.loads(msg_str)
-        try:
-            return msg["message"]
-        except KeyError:
-            return ""
+        return msg["message"]
+
+    def put(self, topic, msg_body):
+        msg_dict = {"action": "put", "topic": topic, "message": msg_body}
+        _send_message(self.dsmq_conn, msg_dict)
+
+
+def _send_message(socket_conn, msg_dict):
+    msg = json.dumps(msg_dict)
+    msg_bytes = bytes(msg, "utf-8")
+    n_bytes = len(msg_bytes)
+
+    # Send a header first.
+    # Add a large number to ensure that the message is the same size each time.
+    header_dict = {"msg_length": n_bytes + _message_length_offset}
+    header = json.dumps(header_dict)
+    header_bytes = bytes(header, "utf-8")
+    socket_conn.sendall(header_bytes)
 
-    def put(self, topic, msg):
-        msg = json.dumps({"action": "put", "topic": topic, "message": msg})
-        self.dsmq_conn.sendall(bytes(msg, "utf-8"))
+    socket_conn.sendall(msg_bytes)
+
+
+def _receive_message(socket_conn):
+    # First receive a header
+    header_data = socket_conn.recv(_header_length)
+    if header_data is None:
+        return None
+    if len(header_data) == 0:
+        return None
+
+    header_str = header_data.decode("utf-8")
+    header = json.loads(header_str)
+    msg_length = header["msg_length"] - _message_length_offset
+
+    data = socket_conn.recv(msg_length)
+    if data is None:
+        return None
+    if len(data) == 0:
+        return None
+
+    msg_str = data.decode("utf-8")
+    msg = json.loads(msg_str)
+    return msg
 
 
 def _handle_client_connection(socket_conn):
@@ -86,20 +118,10 @@ def _handle_client_connection(socket_conn):
     time_of_last_purge = time.time()
 
     while True:
-        data = socket_conn.recv(1024)
-        # Check whether the connection has been terminated
-        if not data:
+        msg = _receive_message(socket_conn)
+        if msg is None:
             break
 
-        msg_str = data.decode("utf-8")
-        try:
-            # print("dsmq received ", msg_str)
-            msg = json.loads(msg_str)
-        except json.decoder.JSONDecodeError:
-            print("Message must be json-friendly")
-            print(f"    Received: {msg}")
-            continue
-
         topic = msg["topic"]
         timestamp = time.time()
 
@@ -108,7 +130,7 @@ def _handle_client_connection(socket_conn):
 
             # This block allows for multiple retries if the database
             # is busy.
-            for i_retry in range(N_RETRIES):
+            for i_retry in range(_n_retries):
                 try:
                     cursor.execute(
                         """
@@ -119,7 +141,7 @@ VALUES (:timestamp, :topic, :message)
                     )
                     sqlite_conn.commit()
                 except sqlite3.OperationalError:
-                    wait_time = FIRST_RETRY * 2**i_retry
+                    wait_time = _first_retry * 2**i_retry
                     time.sleep(wait_time)
                     continue
                 break
@@ -134,7 +156,7 @@ VALUES (:timestamp, :topic, :message)
 
             # This block allows for multiple retries if the database
             # is busy.
-            for i_retry in range(N_RETRIES):
+            for i_retry in range(_n_retries):
                 try:
                     cursor.execute(
                         """
@@ -153,7 +175,7 @@ AND timestamp = a.min_time
                         msg,
                     )
                 except sqlite3.OperationalError:
-                    wait_time = FIRST_RETRY * 2**i_retry
+                    wait_time = _first_retry * 2**i_retry
                     time.sleep(wait_time)
                     continue
                 break
@@ -167,15 +189,14 @@ AND timestamp = a.min_time
                 # Handle the case where no results are returned
                 message = ""
 
-            msg = json.dumps({"message": message})
-            socket_conn.sendall(bytes(msg, "utf-8"))
+            _send_message(socket_conn, {"message": message})
         else:
             print("Action must either be 'put' or 'get'")
 
         # Periodically clean out messages from the queue that are
         # past their sell buy date.
         # This operation is pretty fast. I clock it at 12 us on my machine.
-        if time.time() - time_of_last_purge > TIME_TO_LIVE:
+        if time.time() - time_of_last_purge > _time_to_live:
             cursor.execute(
                 """
 DELETE FROM messages

{dsmq-0.5.0.dist-info → dsmq-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dsmq
-Version: 0.5.0
+Version: 0.7.0
 Summary: A dead simple message queue
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -97,6 +97,8 @@ a queue before it connected.
 - A client will get the oldest message available on a requested topic.
 Queues are first-in-first-out.
 
+- Messages older than 600 seconds will be deleted from the queue.
+
 - Put and get operations are fairly quick--less than 100 $`\mu`$s of processing
 time plus any network latency--so it can comfortably handle requests at rates of
 hundreds of times per second. But if you have several clients reading and writing
@@ -127,7 +129,7 @@ Connects to an existing message queue server.
 ## `DSMQClientSideConnection` class
 
 This is a convenience wrapper, to make the `get()` and `put()` functions
-easy to write and remember.
+easy to write and remember. It's under the hood only, not meant to be called directly.
 
 ### `put(topic, msg)`
 
@@ -143,4 +145,4 @@ connected to the server.
 - `topic` (str)
 - returns str, the content of the message. If there was no eligble message
 in the topic, or the topic doesn't yet exist,
-returns "".
+returns `""`.

{dsmq-0.5.0.dist-info → dsmq-0.7.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
 dsmq/__init__.py,sha256=YCgbnQAk8YbtHRyMcU0v2O7RdRhPhlT-vS_q40a7Q6g,50
 dsmq/demo_linux.py,sha256=7yLglGmirDLuuyMxppYSK-dfx2Fg2Q0dIWB4cl2yV1c,622
-dsmq/dsmq.py,sha256=dKYtGkg8Kwll2sCytCqSI5klFs2cwm2pyXAkyQk4RdU,6206
+dsmq/dsmq.py,sha256=f-dR-Pjjn_gDx-EK1evYQWvDq8ypXbhx6DaCWHCInSc,6744
 dsmq/example_get_client.py,sha256=chFfB2949PBENmgdUc3ASrATq1m4wvHGBzEnOC-o_Xs,296
 dsmq/example_put_client.py,sha256=mUKCRhmUieMZEpHLFWFvzeKB6IR7A8l4tWN8TvPzdKU,348
 dsmq/example_server.py,sha256=kkXOPaaTzVxf9_iIM76zU9pZhkPna_1vcGWkPrhCjus,61
-dsmq-0.5.0.dist-info/METADATA,sha256=EQISO0WcVsb7smXIie-ZP7pIO1itY8FZfjGw3DPuZDM,3878
-dsmq-0.5.0.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
-dsmq-0.5.0.dist-info/licenses/LICENSE,sha256=3Yu1mAp5VsKmnDtzkiOY7BdmrLeNwwZ3t6iWaLnlL0Y,1071
-dsmq-0.5.0.dist-info/RECORD,,
+dsmq-0.7.0.dist-info/METADATA,sha256=NFG4GQwX9RqIKLR3xvFelzuTVebieS4sJqZ9uFu24Lw,4006
+dsmq-0.7.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+dsmq-0.7.0.dist-info/licenses/LICENSE,sha256=3Yu1mAp5VsKmnDtzkiOY7BdmrLeNwwZ3t6iWaLnlL0Y,1071
+dsmq-0.7.0.dist-info/RECORD,,

{dsmq-0.5.0.dist-info → dsmq-0.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.1
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any