wgengine/magicsock: add immutability documentation to endpointDisco

Updates #7825 Signed-off-by: James Tucker <james@tailscale.com>
3 years ago · a257b2f88b
parent fb18af5564
commit a257b2f88b
1 changed files with 2 additions and 0 deletions
--- a/wgengine/magicsock/magicsock.go
+++ b/wgengine/magicsock/magicsock.go
@ -4085,6 +4085,8 @@ func ippDebugString(ua netip.AddrPort) string {
 // recalculated.
 type endpointSendFunc func([][]byte) error

+// endpointDisco is the current disco key and short string for an endpoint. This
+// structure is immutable.
 type endpointDisco struct {
 	key   key.DiscoPublic // for discovery messages.
 	short string          // ShortString of discoKey.