chore: add warning to Start comment to inform about possible race c…

…onditions
go-ldap · Apr 12, 2024 · b761e46 · b761e46
1 parent 5abb12b
commit b761e46
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/conn.go b/conn.go
@@ -265,7 +265,11 @@ func NewConn(conn net.Conn, isTLS bool) *Conn {
 	return l
 }
 
-// Start initializes goroutines to read responses and process messages
+// Start initialises goroutines to read replies and process messages.
+// Warning: Calling this function in addition to Dial or DialURL
+// may cause race conditions.
+//
+// See: https://github.com/go-ldap/ldap/issues/356
 func (l *Conn) Start() {
 	go l.reader()
 	go l.processMessages()

diff --git a/v3/conn.go b/v3/conn.go
@@ -265,7 +265,11 @@ func NewConn(conn net.Conn, isTLS bool) *Conn {
 	return l
 }
 
-// Start initializes goroutines to read responses and process messages
+// Start initialises goroutines to read replies and process messages.
+// Warning: Calling this function in addition to Dial or DialURL
+// may cause race conditions.
+//
+// See: https://github.com/go-ldap/ldap/issues/356
 func (l *Conn) Start() {
 	go l.reader()
 	go l.processMessages()