chore: add comment to Start function to inform about possible insta…

…bility when called (#499)
go-ldap · Apr 1, 2024 · f09ee91 · f09ee91
1 parent 450e034
commit f09ee91
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/conn.go b/conn.go
@@ -265,7 +265,12 @@ 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.
+//
+// Deprecated: It is usually not necessary to call this function
+// manually. It is public for compatibility reasons and may
+// cause a race condition when processing messages.
+// 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,12 @@ 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.
+//
+// Deprecated: It is usually not necessary to call this function
+// manually. It is public for compatibility reasons and may
+// cause a race condition when processing messages.
+// See: https://github.com/go-ldap/ldap/issues/356
 func (l *Conn) Start() {
 	go l.reader()
 	go l.processMessages()