hemna/aprsd
1
0
Fork 0
mirror of https://github.com/craigerl/aprsd.git synced 2025-09-04 14:17:48 -04:00
Code Issues Projects Releases Wiki Activity

Updated APRSClient

Browse Source 
Added some doc strings and some types for returns as well
as an exception catching around create_client
This commit is contained in:
Hemna 2024-11-05 11:46:50 -05:00
parent 7e8d7cdf86
commit d808e217a2
1 changed files with 31 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
aprsd/client/base.py
View File

@ -32,7 +32,11 @@ class APRSClient:
@abc.abstractmethod @abc.abstractmethod
def stats(self) -> dict: def stats(self) -> dict:
pass """Return statistics about the client connection.
Returns:
dict: Statistics about the connection and packet handling
"""
def set_filter(self, filter): def set_filter(self, filter):
self.filter = filter self.filter = filter
@ -46,22 +50,31 @@ class APRSClient:
return self._client return self._client
def _create_client(self): def _create_client(self):
self._client = self.setup_connection() try:
if self.filter: self._client = self.setup_connection()
LOG.info("Creating APRS client filter") if self.filter:
self._client.set_filter(self.filter) LOG.info("Creating APRS client filter")
self._client.set_filter(self.filter)
except Exception as e:
LOG.error(f"Failed to create APRS client: {e}")
self._client = None
raise
def stop(self): def stop(self):
if self._client: if self._client:
LOG.info("Stopping client connection.") LOG.info("Stopping client connection.")
self._client.stop() self._client.stop()
def send(self, packet: core.Packet): def send(self, packet: core.Packet) -> None:
"""Send a packet to the network.""" """Send a packet to the network.
Args:
packet: The APRS packet to send
"""
self.client.send(packet) self.client.send(packet)
@wrapt.synchronized(lock) @wrapt.synchronized(lock)
def reset(self): def reset(self) -> None:
"""Call this to force a rebuild/reconnect.""" """Call this to force a rebuild/reconnect."""
LOG.info("Resetting client connection.") LOG.info("Resetting client connection.")
if self._client: if self._client:
@ -76,7 +89,11 @@ class APRSClient:
@abc.abstractmethod @abc.abstractmethod
def setup_connection(self): def setup_connection(self):
pass """Initialize and return the underlying APRS connection.
Returns:
object: The initialized connection object
"""
@staticmethod @staticmethod
@abc.abstractmethod @abc.abstractmethod
@ -90,7 +107,11 @@ class APRSClient:
@abc.abstractmethod @abc.abstractmethod
def decode_packet(self, *args, **kwargs): def decode_packet(self, *args, **kwargs):
pass """Decode raw APRS packet data into a Packet object.
Returns:
Packet: Decoded APRS packet
"""
@abc.abstractmethod @abc.abstractmethod
def consumer(self, callback, blocking=False, immortal=False, raw=False): def consumer(self, callback, blocking=False, immortal=False, raw=False):