Skip to content

Commit

Permalink
Improved documentation and fixed typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rudd-O committed Sep 28, 2016
1 parent 4655f9f commit 80cba8b
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions wrap.go
Expand Up @@ -403,9 +403,11 @@ func WrapClient(conn net.Conn,
//
// When the peer has closed the socket, Read() will return a standard EOF.
//
// If Read() returns an error other than a syscall error such as EOF,
// the socket remains open, but (much like TLS) it is highly unlikely that,
// after your program receivin that error, the connection will continue working.
// Lifecycle Information
//
// If Read() returns an error, the socket remains technically open, but
// (much like TLS) it is highly unlikely that, after your program receives
// the error, the connection will continue working.
//
// It is an error to invoke an EncryptedConn's Read() from a goroutine
// while another goroutine is invoking Read() or ReadFrame() on the same
Expand Down Expand Up @@ -434,9 +436,11 @@ func (w *EncryptedConn) Read(b []byte) (int, error) {
//
// When the peer has closed the socket, ReadFrame() will return a standard EOF.
//
// If ReadFrame() returns an error other than a syscall error such as EOF,
// the socket remains open, but (much like TLS) it is highly unlikely that,
// after your program receivin that error, the connection will continue working.
// Lifecycle Information
//
// If ReadFrame() returns an error, the socket remains technically open, but
// (much like TLS) it is highly unlikely that, after your program receives
// the error, the connection will continue working.
//
// It is an error to call ReadFrame when a previous Read was only partially
// written to its output buffer.
Expand Down

0 comments on commit 80cba8b

Please sign in to comment.