TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-04-04 07:15:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

ipn/ipnstate: add some missing docs

Browse Source 
Updates #cleanup

Change-Id: I689f8124a5986a98b8eb3891727d39c96408f0a7
Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2023-09-09 08:54:14 -07:00 committed by Brad Fitzpatrick
parent db307d35e1
commit 60e9bd6047
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
ipn/ipnstate/ipnstate.go
View File

@ -69,9 +69,16 @@ type Status struct {
// trailing periods, and without any "_acme-challenge." prefix. // trailing periods, and without any "_acme-challenge." prefix.
CertDomains []string CertDomains []string
// Peer is the state of each peer, keyed by each peer's current public key.
Peer map[key.NodePublic]*PeerStatus Peer map[key.NodePublic]*PeerStatus
// User contains profile information about UserIDs referenced by
// PeerStatus.UserID, PeerStatus.AltSharerUserID, etc.
User map[tailcfg.UserID]tailcfg.UserProfile User map[tailcfg.UserID]tailcfg.UserProfile
// ClientVersion, when non-nil, contains information about the latest
// version of the Tailscale client that's available. Depending on
// the platform and client settings, it may not be available.
ClientVersion *tailcfg.ClientVersion ClientVersion *tailcfg.ClientVersion
} }
@ -190,6 +197,7 @@ type PeerStatusLite struct {
NodeKey key.NodePublic NodeKey key.NodePublic
} }
// PeerStatus describes a peer node and its current state.
type PeerStatus struct { type PeerStatus struct {
ID tailcfg.StableNodeID ID tailcfg.StableNodeID
PublicKey key.NodePublic PublicKey key.NodePublic
@ -283,6 +291,9 @@ type PeerStatus struct {
Location *tailcfg.Location `json:",omitempty"` Location *tailcfg.Location `json:",omitempty"`
} }
// StatusBuilder is a request to construct a Status. A new StatusBuilder is
// passed to various subsystems which then call methods on it to populate state.
// Call its Status method to return the final constructed Status.
type StatusBuilder struct { type StatusBuilder struct {
WantPeers bool // whether caller wants peers WantPeers bool // whether caller wants peers
@ -303,6 +314,8 @@ func (sb *StatusBuilder) MutateStatus(f func(*Status)) {
f(&sb.st) f(&sb.st)
} }
// Status returns the status that has been built up so far from previous
// calls to MutateStatus, MutateSelfStatus, AddPeer, etc.
func (sb *StatusBuilder) Status() *Status { func (sb *StatusBuilder) Status() *Status {
sb.mu.Lock() sb.mu.Lock()
defer sb.mu.Unlock() defer sb.mu.Unlock()
@ -667,6 +680,8 @@ func (pr *PingResult) ToPingResponse(pingType tailcfg.PingType) *tailcfg.PingRes
} }
} }
// SortPeers sorts peers by either the DNS name, hostname, Tailscale IP,
// or current public key.
func SortPeers(peers []*PeerStatus) { func SortPeers(peers []*PeerStatus) {
sort.Slice(peers, func(i, j int) bool { return sortKey(peers[i]) < sortKey(peers[j]) }) sort.Slice(peers, func(i, j int) bool { return sortKey(peers[i]) < sortKey(peers[j]) })
} }