device: rename unsafeCloseBind to closeBindLocked

And document a bit.
This name is more idiomatic.

Signed-off-by: Josh Bleecher Snyder <josharian@gmail.com>

diff --git a/device/device.go b/device/device.go
index 3b8770b92c38191eefe741294c4a84241ffb8087..1e32db67d13afa89f01d4bde3a7f335e3d38f309 100644 (file)
--- a/device/device.go
+++ b/device/device.go
@@ -400,7 +400,9 @@ func (device *Device) SendKeepalivesToPeersWithCurrentKeypair() {
        device.peers.RUnlock()
 }
 
-func unsafeCloseBind(device *Device) error {
+// closeBindLocked closes the device's net.bind.
+// The caller must hold the net mutex.
+func closeBindLocked(device *Device) error {
        var err error
        netc := &device.net
        if netc.netlinkCancel != nil {
@@ -455,7 +457,7 @@ func (device *Device) BindUpdate() error {
        defer device.net.Unlock()
 
        // close existing sockets
-       if err := unsafeCloseBind(device); err != nil {
+       if err := closeBindLocked(device); err != nil {
                return err
        }
 
@@ -511,7 +513,7 @@ func (device *Device) BindUpdate() error {
 
 func (device *Device) BindClose() error {
        device.net.Lock()
-       err := unsafeCloseBind(device)
+       err := closeBindLocked(device)
        device.net.Unlock()
        return err
 }