diff mbox series

[BlueZ,v3,2/3] doc/device: Add Disconnected signal

Message ID 20250522154944.665655-3-frederic.danis@collabora.com
State New
Headers show
Series None | expand

Commit Message

Frédéric Danis May 22, 2025, 3:49 p.m. UTC 
---
v1->v2: Replace text reason by numerical reason
	Improve documentation
v2->v3: Replace numerical reason by name and message

 doc/org.bluez.Device.rst | 41 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
diff mbox series

Patch

diff --git a/doc/org.bluez.Device.rst b/doc/org.bluez.Device.rst
index 205f65761..39e51f79c 100644
--- a/doc/org.bluez.Device.rst
+++ b/doc/org.bluez.Device.rst
@@ -155,6 +155,47 @@  array{array{byte}} GetServiceRecords() [experimental]
 	:org.bluez.Error.NotConnected:
 	:org.bluez.Error.DoesNotExist:
 
+Signals
+-------
+
+void Disconnected(string name, string message)
+``````````````````````````````````````````````
+
+	This signal is launched when a device is disconnected, with the reason of
+	the disconnection.
+
+	This could be used by client application, depending on internal policy, to
+	try to reconnect to the device in case of timeout or unknown disconnection,
+	or to try to connect to another device.
+
+	Possible reasons:
+
+	:org.bluez.Reason.Unknown:
+
+	:org.bluez.Reason.Timeout:
+
+		The link supervision timeout has expired for a connection or the
+		synchronization timeout has expired for a broadcast.
+
+	:org.bluez.Reason.Local:
+
+		The local device terminated the connection, terminated synchronization
+		with a broadcaster, or terminated broadcasting packets.
+
+	:org.bluez.Reason.Remote:
+
+		This disconnection can be due to:
+			- the user on the remote device either terminated the connection
+			  or stopped broadcasting packets,
+			- the remote device terminated the connection because of low
+			  resources,
+			- the remote device terminated the connection because the device
+			  is about to power off.
+
+	:org.bluez.Reason.Authentication:
+
+	:org.bluez.Reason.LocalSuspend:
+
 Properties
 ----------