Add: return the length of the data for every send function (#25)

This allows callers to track how much bandwidth was used for sending
replies.

Author: TrueBrain

openttd_protocol/protocol/content.py

@@ -225,7 +225,7 @@ async def send_PACKET_CONTENT_SERVER_INFO(
             write_string(data, tag)
 
         write_presend(data, SEND_TCP_COMPAT_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_CONTENT_SERVER_CONTENT(self, content_type, content_id, filesize, filename, stream):
         # First, send a packet to tell the client it will be receiving a file
@@ -238,15 +238,16 @@ async def send_PACKET_CONTENT_SERVER_CONTENT(self, content_type, content_id, fil
         write_string(data, filename)
 
         write_presend(data, SEND_TCP_COMPAT_MTU)
-        await self.send_packet(data)
+        length = await self.send_packet(data)
 
         # Next, send the content of the file over
         while not stream.eof():
             data = write_init(PacketContentType.PACKET_CONTENT_SERVER_CONTENT)
             data += stream.read(SEND_TCP_COMPAT_MTU - 3)
             write_presend(data, SEND_TCP_COMPAT_MTU)
-            await self.send_packet(data)
+            length += await self.send_packet(data)
 
         data = write_init(PacketContentType.PACKET_CONTENT_SERVER_CONTENT)
         write_presend(data, SEND_TCP_COMPAT_MTU)
-        await self.send_packet(data)
+        length += await self.send_packet(data)
+        return length

openttd_protocol/protocol/coordinator.py

@@ -356,7 +356,7 @@ async def send_PACKET_COORDINATOR_GC_ERROR(self, protocol_version, error_no, err
         write_string(data, error_detail)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_REGISTER_ACK(
         self, protocol_version, connection_type, invite_code, invite_code_secret
@@ -369,7 +369,7 @@ async def send_PACKET_COORDINATOR_GC_REGISTER_ACK(
         write_uint8(data, connection_type.value)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     def _fill_NEWGRF_LOOKUP_PACKET(self, newgrf_lookup_table_cursor, newgrf_lookup_table):
         data = bytearray()
@@ -401,6 +401,7 @@ async def send_PACKET_COORDINATOR_GC_NEWGRF_LOOKUP(
     ):
         cursor = max(newgrf_lookup_table.keys())
 
+        length = 0
         for count, body in self._fill_NEWGRF_LOOKUP_PACKET(newgrf_lookup_table_cursor, newgrf_lookup_table):
             data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_NEWGRF_LOOKUP)
 
@@ -411,11 +412,14 @@ async def send_PACKET_COORDINATOR_GC_NEWGRF_LOOKUP(
             write_bytes(data, body)
 
             write_presend(data, SEND_TCP_MTU)
-            await self.send_packet(data)
+            length += await self.send_packet(data)
+
+        return length
 
     async def send_PACKET_COORDINATOR_GC_LISTING(
         self, protocol_version, game_info_version, servers, newgrf_lookup_table
     ):
+        length = 0
         for server in servers:
             if server.game_type != ServerGameType.SERVER_GAME_TYPE_PUBLIC:
                 continue
@@ -483,13 +487,14 @@ async def send_PACKET_COORDINATOR_GC_LISTING(
                 write_uint8(data, server.info["is_dedicated"])
 
             write_presend(data, SEND_TCP_MTU)
-            await self.send_packet(data)
+            length += await self.send_packet(data)
 
         # Send a final packet with 0 servers to indicate end-of-list.
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_LISTING)
         write_uint16(data, 0)
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        length += await self.send_packet(data)
+        return length
 
     async def send_PACKET_COORDINATOR_GC_CONNECTING(self, protocol_version, token, invite_code):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_CONNECTING)
@@ -498,15 +503,15 @@ async def send_PACKET_COORDINATOR_GC_CONNECTING(self, protocol_version, token, i
         write_string(data, invite_code)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_CONNECT_FAILED(self, protocol_version, token):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_CONNECT_FAILED)
 
         write_string(data, token)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_DIRECT_CONNECT(self, protocol_version, token, tracking_number, hostname, port):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_DIRECT_CONNECT)
@@ -517,15 +522,15 @@ async def send_PACKET_COORDINATOR_GC_DIRECT_CONNECT(self, protocol_version, toke
         write_uint16(data, port)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_STUN_REQUEST(self, protocol_version, token):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_STUN_REQUEST)
 
         write_string(data, token)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_STUN_CONNECT(
         self, protocol_version, token, tracking_number, interface_number, hostname, port
@@ -539,7 +544,7 @@ async def send_PACKET_COORDINATOR_GC_STUN_CONNECT(
         write_uint16(data, port)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)
 
     async def send_PACKET_COORDINATOR_GC_TURN_CONNECT(
         self, protocol_version, token, tracking_number, ticket, connection_string
@@ -552,4 +557,4 @@ async def send_PACKET_COORDINATOR_GC_TURN_CONNECT(
         write_string(data, connection_string)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)

openttd_protocol/protocol/game.py

@@ -167,4 +167,4 @@ def receive_PACKET_SERVER_SHUTDOWN(source, data):
     async def send_PACKET_CLIENT_GAME_INFO(self):
         data = write_init(PacketGameType.PACKET_CLIENT_GAME_INFO)
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)

openttd_protocol/protocol/turn.py

@@ -48,4 +48,4 @@ async def send_PACKET_TURN_TURN_CONNECTED(self, protocol_version, hostname):
         write_string(data, hostname)
 
         write_presend(data, SEND_TCP_MTU)
-        await self.send_packet(data)
+        return await self.send_packet(data)

openttd_protocol/wire/tcp.py

@@ -217,3 +217,5 @@ async def send_packet(self, data):
         # everything else, it is a non-blocking normal function.
         if iscoroutine(res):
             await res
+
+        return len(data)