From a816e8511eb45975e8e0e4199c3481989953fd56 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Tue, 9 Feb 2021 15:35:43 +0100 Subject: device: fix comment typo and shorten state.mu.Lock to state.Lock Signed-off-by: Jason A. Donenfeld --- device/device.go | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) (limited to 'device/device.go') diff --git a/device/device.go b/device/device.go index 935f41b..0417397 100644 --- a/device/device.go +++ b/device/device.go @@ -24,9 +24,8 @@ 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.mu is (r)locked, state is the current state of the device. - // Without state.mu (r)locked, state is either the current state - // of the device or the intended future state of the device. + // 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. // 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. @@ -36,7 +35,7 @@ type Device struct { // stopping blocks until all inputs to Device have been closed. stopping sync.WaitGroup // mu protects state changes. - mu sync.Mutex + sync.Mutex } net struct { @@ -145,8 +144,8 @@ func unsafeRemovePeer(device *Device, peer *Peer, key NoisePublicKey) { // changeState attempts to change the device state to match want. func (device *Device) changeState(want deviceState) { - device.state.mu.Lock() - defer device.state.mu.Unlock() + device.state.Lock() + defer device.state.Unlock() old := device.deviceState() if old == deviceStateClosed { // once closed, always closed @@ -353,8 +352,8 @@ func (device *Device) RemoveAllPeers() { } func (device *Device) Close() { - device.state.mu.Lock() - defer device.state.mu.Unlock() + device.state.Lock() + defer device.state.Unlock() if device.isClosed() { return } -- cgit v1.2.3-54-g00ecf