Skip to content

Commit bb8191b

Browse files
authored
Merge pull request #13 from pabigot/issue/20210830a
connection: clarify documented behavior of NotifyClose
2 parents 29645df + 4a79eb7 commit bb8191b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

connection.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,8 @@ func (c *Connection) ConnectionState() tls.ConnectionState {
262262
NotifyClose registers a listener for close events either initiated by an error
263263
accompanying a connection.close method or by a normal shutdown.
264264
265-
On normal shutdowns, the chan will be closed.
265+
The chan provided will be closed when the Channel is closed and on a
266+
graceful close, no error will be sent.
266267
267268
To reconnect after a transport or protocol error, register a listener here and
268269
re-run your setup process.

0 commit comments

Comments
 (0)