Index: net/filter/filter.h |
diff --git a/net/filter/filter.h b/net/filter/filter.h |
index 5e6b867cf8b96c9abcce28f6cb4f6a2bd2d9d2a7..4972a0d48f4273fbc6a429e91694c8cd9003c754 100644 |
--- a/net/filter/filter.h |
+++ b/net/filter/filter.h |
@@ -20,10 +20,15 @@ |
// through its accessor and fills in stream_buffer_ with pre-filter data, next |
// calls FlushStreamBuffer to notify Filter, then calls ReadFilteredData |
// repeatedly to get all the filtered data. After all data have been fitlered |
Bence
2014/10/29 20:00:24
s/fitlered/filtered/ once you are here. Thanks.
Randy Smith (Not in Mondays)
2014/10/30 18:35:42
Done.
|
-// and read out, the caller may fill in stream_buffer_ again. This |
+// and read out, the caller may fill in stream_buffer_ again. This |
// WriteBuffer-Flush-Read cycle is repeated until reaching the end of data |
// stream. |
// |
+// A return of FILTER_OK from ReadData() means that more data is |
+// available to a future ReadData() call and data may not be written |
+// into stream_buffer(). A return of FILTER_NEED_MORE_DATA from ReadData() |
+// means that the buffer at stream_buffer() is available for writing. |
+// |
// The lifetime of a Filter instance is completely controlled by its caller. |
#ifndef NET_FILTER_FILTER_H__ |