specs: Document instance_id in local discovery
This commit is contained in:
+11
-5
@@ -22,9 +22,10 @@ broadcast address, or to the generic link-local broadcast address
|
|||||||
For IPv6, the Announcement packet is multicast to the transient link-local
|
For IPv6, the Announcement packet is multicast to the transient link-local
|
||||||
multicast address ``ff12::8384``, with destination port 21027.
|
multicast address ``ff12::8384``, with destination port 21027.
|
||||||
|
|
||||||
It is recommended that local discovery Announcement packets be sent on a 30 to
|
It is recommended that local discovery Announcement packets be sent on a 30
|
||||||
60 second interval, possibly with immediate transmissions when a previously
|
to 60 second interval, possibly with immediate transmissions when a
|
||||||
unknown device is discovered.
|
previously unknown device is discovered or a device has restarted (see the
|
||||||
|
``instance_id`` field).
|
||||||
|
|
||||||
Device ID
|
Device ID
|
||||||
---------
|
---------
|
||||||
@@ -62,8 +63,9 @@ following schema:
|
|||||||
.. code-block:: proto
|
.. code-block:: proto
|
||||||
|
|
||||||
message Announce {
|
message Announce {
|
||||||
bytes id = 1;
|
bytes id = 1;
|
||||||
repeated string addresses = 2;
|
repeated string addresses = 2;
|
||||||
|
int64 instance_id = 3;
|
||||||
}
|
}
|
||||||
|
|
||||||
The ``id`` field contains the Device ID of the sending device.
|
The ``id`` field contains the Device ID of the sending device.
|
||||||
@@ -75,3 +77,7 @@ Relay connections will typically use the ``relay://`` scheme.
|
|||||||
When interpreting addresses with an unspecified address, e.g.,
|
When interpreting addresses with an unspecified address, e.g.,
|
||||||
``tcp://0.0.0.0:22000`` or ``tcp://:42424``, the source address of the
|
``tcp://0.0.0.0:22000`` or ``tcp://:42424``, the source address of the
|
||||||
discovery announcement is to be used.
|
discovery announcement is to be used.
|
||||||
|
|
||||||
|
The ``instance_id`` field is set to a randomly generated ID at client
|
||||||
|
startup. Other devices on the network can detect a change in instance ID
|
||||||
|
between two announces and conclude that the announcing device has restarted.
|
||||||
|
|||||||
Reference in New Issue
Block a user