ENHANCEMENTS:

- Ports have a tag if they are UDP or TCP (or both) now
- /doc command shows tcp/udp notation in server documentation
- /doc new node sheet added to server documentation

CHANGES
- Some code cleanups

BUGFIX:
- Rare hangup if a DCS server starts non-responsive

Author: karel26

core/data/const.py

@@ -4,7 +4,9 @@
     "Side",
     "Status",
     "Coalition",
-    "Channel"
+    "Channel",
+    "PortType",
+    "Port",
 ]
 
 
@@ -44,3 +46,41 @@ class Channel(Enum):
     COALITION_BLUE_EVENTS = 'blue_events'
     COALITION_RED_CHAT = 'red'
     COALITION_RED_EVENTS = 'red_events'
+
+
+class PortType(Enum):
+    TCP = 'tcp'
+    UDP = 'udp'
+    BOTH = 'tcp+udp'
+
+
+class Port:
+
+    def __init__(self, port: int, typ: PortType):
+        self.port = port
+        self.typ = typ
+
+    def __repr__(self):
+        return f'{self.port}/{self.typ.value}'
+
+    def __str__(self):
+        return str(self.port)
+
+    def __int__(self):
+        return self.port
+
+    def __index__(self):
+        return self.port
+
+    def __hash__(self):
+        return hash(self.port)
+
+    def __eq__(self, other):
+        if isinstance(other, Port):
+            return self.port == other.port
+        elif isinstance(other, int):
+            return self.port == other
+        return False
+
+    def type(self):
+        return self.typ

core/data/dataobject.py

@@ -2,6 +2,7 @@
 
 import logging
 
+from abc import ABC
 from configparser import ConfigParser
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Callable, Type, TypeVar, Generic, ClassVar, Any
@@ -18,7 +19,7 @@
 
 
 @dataclass
-class DataObject:
+class DataObject(ABC):
     name: str
     node: Node = field(compare=False, repr=False)
     pool: ConnectionPool = field(compare=False, repr=False, init=False)
@@ -36,6 +37,11 @@ def __post_init__(self):
     def __hash__(self):
         return hash(self.name)
 
+    def __eq__(self, other):
+        if isinstance(other, DataObject):
+            return self.name == other.name
+        return False
+
 
 T = TypeVar("T", bound=DataObject)
 

core/data/impl/instanceimpl.py

@@ -9,6 +9,7 @@
 from core.utils.helper import SettingsDict
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
+from typing_extensions import override
 
 if TYPE_CHECKING:
     from core import Server
@@ -20,6 +21,7 @@
 @DataObjectFactory.register()
 class InstanceImpl(Instance):
 
+    @override
     def __post_init__(self):
         super().__post_init__()
         self.is_remote = False
@@ -86,6 +88,7 @@ def update_instance(self, server_name: str | None = None):
             self.log.error(f"bot_port {self.locals.get('bot_port', 6666)} is already in use on node {self.node.name}!")
             raise
 
+    @override
     @property
     def home(self) -> str:
         return os.path.expandvars(self.locals.get('home', os.path.join(SAVED_GAMES, self.name)))
@@ -98,6 +101,7 @@ def update_server(self, server: Server | None = None):
                     WHERE node = %s AND instance = %s
                 """, (server.name if server and server.name != 'n/a' else None, self.node.name, self.name))
 
+    @override
     def set_server(self, server: Server | None):
         if self._server and self._server.status not in [Status.UNREGISTERED, Status.SHUTDOWN]:
             raise InstanceBusyError()
@@ -107,12 +111,12 @@ def set_server(self, server: Server | None):
             settings_path = os.path.join(self.home, 'Config', 'serverSettings.lua')
             if os.path.exists(settings_path):
                 os.remove(settings_path)
-        self.prepare()
+        self._prepare()
         if server and server.name:
             server.instance = self
         self.update_server(server)
 
-    def prepare(self):
+    def _prepare(self):
         if 'DCS' not in self.node.locals:
             return
         # desanitisation of Slmod (if there)