rkp/amneziawg-go
1
0 Fork 0
mirror of https://github.com/amnezia-vpn/amneziawg-go.git synced 2026-10-16 22:44:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

device: clarify device.state.state docs (again)

Browse Source 
Signed-off-by: Josh Bleecher Snyder <josh@tailscale.com>
This commit is contained in:
Josh Bleecher Snyder authored and Jason A. Donenfeld committed 2021-02-09 18:29:01 +01:00
1 parent 465261310b
commit cae090d116
1 file changed
+4 -2
Download Patch File Download Diff File Expand all files Collapse all files
device/device.go
+4 -2
View File
@@ -24,8 +24,10 @@ type Device struct {
state struct {
// state holds the device's state. It is accessed atomically.
// Use the device.deviceState method to read it.
// If state is not locked, state is the current state of the device.
// If state is locked, state is the current state or intended future state of the device.
// device.deviceState does not acquire the mutex, so it captures only a snapshot.
// During state transitions, the state variable is updated before the device itself.
// The state is thus either the current state of the device or
// the intended future state of the device.
// For example, while executing a call to Up, state will be deviceStateUp.
// There is no guarantee that that intended future state of the device
// will become the actual state; Up can fail.