From f48f7aacfbfbe99bd1144cb1d86ea157739f9fa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mose=20M=C3=BCller?= Date: Thu, 22 May 2025 16:10:22 +0200 Subject: [PATCH] docs: updates client_id description --- docs/user-guide/interaction/Python-Client.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/interaction/Python-Client.md b/docs/user-guide/interaction/Python-Client.md index 2ac5190..1e910cb 100644 --- a/docs/user-guide/interaction/Python-Client.md +++ b/docs/user-guide/interaction/Python-Client.md @@ -58,7 +58,7 @@ class MyService(pydase.DataService): proxy = pydase.Client( url="ws://:", block_until_connected=False, - client_id="my_pydase_client_id", + client_id="my_pydase_client_id", # optional, defaults to system hostname ).proxy # For SSL-encrypted services, use the wss protocol @@ -77,7 +77,7 @@ if __name__ == "__main__": In this example: - The `MyService` class has a `proxy` attribute that connects to a `pydase` service at `:`. - By setting `block_until_connected=False`, the service can start without waiting for the connection to succeed. -- By setting `client_id`, the server will log a descriptive identifier for this client via the `X-Client-Id` HTTP header. +- The `client_id` is optional. If not specified, it defaults to the system hostname, which will be sent in the `X-Client-Id` HTTP header for logging or authentication on the server side. ## Custom `socketio.AsyncClient` Connection Parameters