Adds comment about SessionOpts.

8 years ago · 556ffc588b
parent 25455c97c3
commit 556ffc588b
1 changed files with 2 additions and 2 deletions
--- a/api/lock.go
+++ b/api/lock.go
@ -73,8 +73,8 @@ type LockOptions struct {
 	Value            []byte        // Optional, value to associate with the lock
 	Session          string        // Optional, created if not specified
 	SessionOpts      *SessionEntry // Optional, options to use when creating a session
-	SessionName      string        // Optional, defaults to DefaultLockSessionName
-	SessionTTL       string        // Optional, defaults to DefaultLockSessionTTL
+	SessionName      string        // Optional, defaults to DefaultLockSessionName (ignored if SessionOpts is given)
+	SessionTTL       string        // Optional, defaults to DefaultLockSessionTTL (ignored if SessionOpts is given)
 	MonitorRetries   int           // Optional, defaults to 0 which means no retries
 	MonitorRetryTime time.Duration // Optional, defaults to DefaultMonitorRetryTime
 	LockWaitTime     time.Duration // Optional, defaults to DefaultLockWaitTime