Skip to content

Commit e2d44e3

Browse files
committed
Document why NetConn is included in the library.
1 parent 4d72b51 commit e2d44e3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

netconn.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ import (
1212

1313
// NetConn converts a *websocket.Conn into a net.Conn.
1414
//
15+
// It's for tunneling arbitrary protocols over WebSockets.
16+
// Few users of the library will need this but it's tricky to implement
17+
// correctly and so provided in the library.
18+
// See https://github.com/nhooyr/websocket/issues/100.
19+
//
1520
// Every Write to the net.Conn will correspond to a binary message
1621
// write on *webscoket.Conn.
1722
//

0 commit comments

Comments
 (0)