Skip to content

Commit 4ac9097

Browse files
authored
Improve control message handler doc
Fixes #338
1 parent 91f589d commit 4ac9097

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

conn.go

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,8 +1051,9 @@ func (c *Conn) CloseHandler() func(code int, text string) error {
10511051
// if the close message is empty. The default close handler sends a close
10521052
// message back to the peer.
10531053
//
1054-
// The application must read the connection to process close messages as
1055-
// described in the section on Control Messages above.
1054+
// The handler function is called from the NextReader, ReadMessage and message
1055+
// reader Read methods. The application must read the connection to process
1056+
// close messages as described in the section on Control Messages above.
10561057
//
10571058
// The connection read methods return a CloseError when a close message is
10581059
// received. Most applications should handle close messages as part of their
@@ -1079,8 +1080,9 @@ func (c *Conn) PingHandler() func(appData string) error {
10791080
// The appData argument to h is the PING message application data. The default
10801081
// ping handler sends a pong to the peer.
10811082
//
1082-
// The application must read the connection to process ping messages as
1083-
// described in the section on Control Messages above.
1083+
// The handler function is called from the NextReader, ReadMessage and message
1084+
// reader Read methods. The application must read the connection to process
1085+
// ping messages as described in the section on Control Messages above.
10841086
func (c *Conn) SetPingHandler(h func(appData string) error) {
10851087
if h == nil {
10861088
h = func(message string) error {
@@ -1105,8 +1107,9 @@ func (c *Conn) PongHandler() func(appData string) error {
11051107
// The appData argument to h is the PONG message application data. The default
11061108
// pong handler does nothing.
11071109
//
1108-
// The application must read the connection to process ping messages as
1109-
// described in the section on Control Messages above.
1110+
// The handler function is called from the NextReader, ReadMessage and message
1111+
// reader Read methods. The application must read the connection to process
1112+
// pong messages as described in the section on Control Messages above.
11101113
func (c *Conn) SetPongHandler(h func(appData string) error) {
11111114
if h == nil {
11121115
h = func(string) error { return nil }

0 commit comments

Comments
 (0)