From 56ebb76c000fd56ba46baf64781a8c2df18955cd Mon Sep 17 00:00:00 2001
From: chengduoZH <zhaochengduo@163.com>
Date: Wed, 7 Feb 2018 15:48:50 +0800
Subject: [PATCH] add the properties of buffered channel and unbuffered channel

---
 paddle/framework/channel_test.cc              | 4 ++--
 paddle/framework/details/buffered_channel.h   | 9 +++++----
 paddle/framework/details/unbuffered_channel.h | 7 +++++++
 3 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/paddle/framework/channel_test.cc b/paddle/framework/channel_test.cc
index 3b8150b427..95360d7b77 100644
--- a/paddle/framework/channel_test.cc
+++ b/paddle/framework/channel_test.cc
@@ -149,7 +149,7 @@ void ChannelCloseUnblocksReceiversTest(Channel<int> *ch) {
   std::thread t[num_threads];
   bool thread_ended[num_threads];
 
-  // Launches threads that try to read and are blocked becausew of no writers
+  // Launches threads that try to read and are blocked because of no writers
   for (size_t i = 0; i < num_threads; i++) {
     thread_ended[i] = false;
     t[i] = std::thread(
@@ -167,7 +167,7 @@ void ChannelCloseUnblocksReceiversTest(Channel<int> *ch) {
     EXPECT_EQ(thread_ended[i], false);
   }
 
-  // Explicitly close the thread
+  // Explicitly close the channel
   // This should unblock all receivers
   CloseChannel(ch);
 
diff --git a/paddle/framework/details/buffered_channel.h b/paddle/framework/details/buffered_channel.h
index 44bf84eb30..4275f919ba 100644
--- a/paddle/framework/details/buffered_channel.h
+++ b/paddle/framework/details/buffered_channel.h
@@ -27,11 +27,12 @@ namespace details {
 
 // Four of the properties of Buffered Channel:
 // - A send to a full channel blocks temporarily until a receive from the
-// channel or the channel is closed
+// channel or the channel is closed.
 // - A receive from an empty channel blocks temporarily until a send to the
-// channel or the channel is closed
-// - A send to a closed channel returns false immediately
-// - A receive from a closed channel returns false immediately
+// channel or the channel is closed.
+// - A send to a closed channel returns false immediately.
+// - A receive from a closed channel returns false immediately.
+
 template <typename T>
 class Buffered : public paddle::framework::Channel<T> {
   friend Channel<T>* paddle::framework::MakeChannel<T>(size_t);
diff --git a/paddle/framework/details/unbuffered_channel.h b/paddle/framework/details/unbuffered_channel.h
index 815cebad2d..bc4233af73 100644
--- a/paddle/framework/details/unbuffered_channel.h
+++ b/paddle/framework/details/unbuffered_channel.h
@@ -23,6 +23,13 @@ namespace paddle {
 namespace framework {
 namespace details {
 
+// Four of the properties of UnBuffered Channel:
+// - A send to a channel blocks temporarily until a receive from the
+// channel or the channel is closed.
+// - A receive from a channel blocks temporarily until a send to the
+// channel or the channel is closed.
+// - A send to a closed channel returns false immediately.
+// - A receive from a closed channel returns false immediately.
 template <typename T>
 class UnBuffered : public paddle::framework::Channel<T> {
   friend Channel<T>* paddle::framework::MakeChannel<T>(size_t);
-- 
GitLab