Document absence of IPv6 link local address support

XCM doesn't support link local (fe80::/10) addresses, which wasn't mentioned in the API documentation. Signed-off-by: Mattias Rönnblom <[email protected]>
Ericsson · Sep 3, 2021 · 262e21d · 262e21d
1 parent c4de7f8
commit 262e21d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/include/xcm.h b/include/xcm.h
@@ -116,6 +116,8 @@ extern "C" {
  * interfaces).  '[*]' is the IPv6 equivalent, creating a server
  * socket accepting connections on all IPv4 and IPv6 addresses.
  *
+ * IPv6 link local addresses are not supported.
+ *
  * Some examples addresses:
  * @code
  * tcp:*:4711