comments

common/io/reader.go

@@ -33,6 +33,7 @@ type AdaptiveReader struct {
 }
 
 // NewAdaptiveReader creates a new AdaptiveReader.
+// The AdaptiveReader instance doesn't take the ownership of reader.
 func NewAdaptiveReader(reader io.Reader) *AdaptiveReader {
 	return &AdaptiveReader{
 		reader:   reader,

common/io/writer.go

@@ -26,7 +26,7 @@ func NewAdaptiveWriter(writer io.Writer) *AdaptiveWriter {
 	}
 }
 
-// Write implements Writer.Write().
+// Write implements Writer.Write(). Write() takes ownership of the given buffer.
 func (this *AdaptiveWriter) Write(buffer *alloc.Buffer) error {
 	nBytes, err := this.writer.Write(buffer.Value)
 	if nBytes < buffer.Len() {

common/protocol/raw/server.go

@@ -24,12 +24,15 @@ type ServerSession struct {
 	responseWriter  io.Writer
 }
 
+// NewServerSession creates a new ServerSession, using the given UserValidator.
+// The ServerSession instance doesn't take ownership of the validator.
 func NewServerSession(validator protocol.UserValidator) *ServerSession {
 	return &ServerSession{
 		userValidator: validator,
 	}
 }
 
+// Release implements common.Releaseable.
 func (this *ServerSession) Release() {
 	this.userValidator = nil
 	this.requestBodyIV = nil