From 62db7e596ef8b2777956ee16ec1ea81ec5209ba1 Mon Sep 17 00:00:00 2001
From: iamqizhao <toqizhao@gmail.com>
Date: Fri, 3 Apr 2015 16:05:11 -0700
Subject: [PATCH] add some comments

---
 transport/control.go | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/transport/control.go b/transport/control.go
index 3f17ab4c..fc7806a8 100644
--- a/transport/control.go
+++ b/transport/control.go
@@ -153,18 +153,28 @@ func (qb *quotaPool) acquire() <-chan int {
 	return qb.c
 }
 
+// inFlow deals with inbound flow control
 type inFlow struct {
+	// The inbound flow control limit for pending data.
 	limit uint32
-	conn  *inFlow
+	// conn points to the shared connection-level inFlow that is shared
+	// by all streams on that conn. It is nil for the inFlow on the conn
+	// directly.
+	conn *inFlow
 
-	mu          sync.Mutex
+	mu sync.Mutex
+	// pendingData is the overall data which have been received but not been
+	// fully consumed (either pending for application to read or pending for
+	// window update).
 	pendingData uint32
-	// The amount of data user has consumed but grpc has not sent window update
-	// for them. Used to reduce window update frequency. It is always part of
-	// pendingData.
+	// The amount of data the application has consumed but grpc has not sent
+	// window update for them. Used to reduce window update frequency. It is
+	// always part of pendingData.
 	pendingUpdate uint32
 }
 
+// onData is invoked when some data frame is received. It increments not only its
+// own pendingData but also that of the associated connection-level flow.
 func (f *inFlow) onData(n uint32) error {
 	if n == 0 {
 		return nil
@@ -183,6 +193,7 @@ func (f *inFlow) onData(n uint32) error {
 	return nil
 }
 
+// onRead is invoked when the application reads the data.
 func (f *inFlow) onRead(n uint32) uint32 {
 	if n == 0 {
 		return 0
@@ -199,6 +210,8 @@ func (f *inFlow) onRead(n uint32) uint32 {
 	return 0
 }
 
+// restoreConn is invoked when a stream is terminated. It removes its stake in
+// the connection-level flow and resets its own state.
 func (f *inFlow) restoreConn() uint32 {
 	if f.conn == nil {
 		return 0