protocol: mark the disconnected event as destructor

This commit is contained in:
Peter Hutterer 2023-02-10 10:54:45 +10:00
parent cfbb906358
commit 0a8501d882

View file

@ -236,7 +236,7 @@
<entry name="error" value="1" help="an error caused the disconnection"/>
</enum>
<event name="disconnected" since="1">
<event name="disconnected" type="destructor" since="1">
<description summary="disconnection event">
This event may be sent by the EIS implementation immediately before
the client is disconnected.
@ -250,6 +250,10 @@
explanation may contain a string explaining why. This string is
intended to help debugging only and is not guaranteed to stay constant.
The ei_connection object will be destroyed by the
EIS implementation immediately after this event has been sent, a
client must not attempt to use it after that point.
There is no guarantee this event is sent - the connection may be closed
without a disconnection event.
</description>