ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-24 01:50:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

breaking: client takes url instead of hostname and port

Browse Source 
Connecting to secure services (with wss) was not possible.
The user has to provide the whole URL now, which makes it much more flexible and less bug-prone.
This commit is contained in:
Mose Müller 2024-08-12 13:15:17 +02:00
parent 014a7b9492
commit 42357d7901
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/pydase/client/client.py
View File

@ -80,12 +80,12 @@ class Client:
if it were local. if it were local.
Args: Args:
hostname (str): url (str):
Hostname of the exposed service this client attempts to connect to. The URL of the pydase Socket.IO server. This should always contain the
Default is "localhost". protocol and the hostname.
port (int): Examples:
Port of the exposed service this client attempts to connect on. - wss://my-service.example.com # for secure connections, use wss
Default is 8001. - ws://localhost:8001
block_until_connected (bool): block_until_connected (bool):
If set to True, the constructor will block until the connection to the If set to True, the constructor will block until the connection to the
service has been established. This is useful for ensuring the client is service has been established. This is useful for ensuring the client is
@ -94,12 +94,11 @@ class Client:
def __init__( def __init__(
self, self,
hostname: str, *,
port: int, url: str,
block_until_connected: bool = True, block_until_connected: bool = True,
): ):
self._hostname = hostname self._url = url
self._port = port
self._sio = socketio.AsyncClient() self._sio = socketio.AsyncClient()
self._loop = asyncio.new_event_loop() self._loop = asyncio.new_event_loop()
self.proxy = ProxyClass(sio_client=self._sio, loop=self._loop) self.proxy = ProxyClass(sio_client=self._sio, loop=self._loop)
@ -107,29 +106,41 @@ class Client:
target=asyncio_loop_thread, args=(self._loop,), daemon=True target=asyncio_loop_thread, args=(self._loop,), daemon=True
) )
self._thread.start() self._thread.start()
self.connect(block_until_connected=block_until_connected)
def connect(self, block_until_connected: bool = True) -> None:
connection_future = asyncio.run_coroutine_threadsafe( connection_future = asyncio.run_coroutine_threadsafe(
self._connect(), self._loop self._connect(), self._loop
) )
if block_until_connected: if block_until_connected:
connection_future.result() connection_future.result()
def disconnect(self) -> None:
connection_future = asyncio.run_coroutine_threadsafe(
self._disconnect(), self._loop
)
connection_future.result()
async def _connect(self) -> None: async def _connect(self) -> None:
logger.debug("Connecting to server '%s:%s' ...", self._hostname, self._port) logger.debug("Connecting to server '%s' ...", self._url)
await self._setup_events() await self._setup_events()
await self._sio.connect( await self._sio.connect(
f"ws://{self._hostname}:{self._port}", self._url,
socketio_path="/ws/socket.io", socketio_path="/ws/socket.io",
transports=["websocket"], transports=["websocket"],
retry=True, retry=True,
) )
async def _disconnect(self) -> None:
await self._sio.disconnect()
async def _setup_events(self) -> None: async def _setup_events(self) -> None:
self._sio.on("connect", self._handle_connect) self._sio.on("connect", self._handle_connect)
self._sio.on("disconnect", self._handle_disconnect) self._sio.on("disconnect", self._handle_disconnect)
self._sio.on("notify", self._handle_update) self._sio.on("notify", self._handle_update)
async def _handle_connect(self) -> None: async def _handle_connect(self) -> None:
logger.debug("Connected to '%s:%s' ...", self._hostname, self._port) logger.debug("Connected to '%s' ...", self._url)
serialized_object = cast( serialized_object = cast(
SerializedDataService, await self._sio.call("service_serialization") SerializedDataService, await self._sio.call("service_serialization")
) )
@ -141,7 +152,7 @@ class Client:
self.proxy._connected = True self.proxy._connected = True
async def _handle_disconnect(self) -> None: async def _handle_disconnect(self) -> None:
logger.debug("Disconnected from '%s:%s' ...", self._hostname, self._port) logger.debug("Disconnected from '%s' ...", self._url)
self.proxy._connected = False self.proxy._connected = False
async def _handle_update(self, data: NotifyDict) -> None: async def _handle_update(self, data: NotifyDict) -> None: