aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpcpp/impl/codegen/async_stream.h
diff options
context:
space:
mode:
authorGravatar Yash Tibrewal <yashkt@google.com>2018-08-17 14:58:01 -0700
committerGravatar Yash Tibrewal <yashkt@google.com>2018-08-17 14:58:01 -0700
commitf80af5a7c753f18f0f15ab6b377949fc4b06d69f (patch)
treeffae6850141c4501c85be42b04d0e3dc3e976f30 /include/grpcpp/impl/codegen/async_stream.h
parent356fff684a63f9503c4ff4d7b22ef7bd20f3aa12 (diff)
Formatting
Diffstat (limited to 'include/grpcpp/impl/codegen/async_stream.h')
-rw-r--r--include/grpcpp/impl/codegen/async_stream.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/include/grpcpp/impl/codegen/async_stream.h b/include/grpcpp/impl/codegen/async_stream.h
index cd433e4869..5df849f610 100644
--- a/include/grpcpp/impl/codegen/async_stream.h
+++ b/include/grpcpp/impl/codegen/async_stream.h
@@ -112,9 +112,10 @@ class AsyncWriterInterface {
/// Only one write may be outstanding at any given time. This means that
/// after calling Write, one must wait to receive \a tag from the completion
/// queue BEFORE calling Write again.
+ /// This is thread-safe with respect to \a AsyncReaderInterface::Read
+ ///
/// GRPC doesn't take ownership or a reference to \a msg, so it is safe to
/// to deallocate once Write returns.
- /// This is thread-safe with respect to \a AsyncReaderInterface::Read
///
/// \param[in] msg The message to be written.
/// \param[in] tag The tag identifying the operation.
@@ -126,11 +127,12 @@ class AsyncWriterInterface {
/// Only one write may be outstanding at any given time. This means that
/// after calling Write, one must wait to receive \a tag from the completion
/// queue BEFORE calling Write again.
- /// GRPC doesn't take ownership or a reference to \a msg, so it is safe to
- /// to deallocate once Write returns.
/// WriteOptions \a options is used to set the write options of this message.
/// This is thread-safe with respect to \a AsyncReaderInterface::Read
///
+ /// GRPC doesn't take ownership or a reference to \a msg, so it is safe to
+ /// to deallocate once Write returns.
+ ///
/// \param[in] msg The message to be written.
/// \param[in] options The WriteOptions to be used to write this message.
/// \param[in] tag The tag identifying the operation.
@@ -147,6 +149,7 @@ class AsyncWriterInterface {
/// and write is initiated. Note that WriteLast can only buffer \a msg up to
/// the flow control window size. If \a msg size is larger than the window
/// size, it will be sent on wire without buffering.
+ ///
/// GRPC doesn't take ownership or a reference to \a msg, so it is safe to
/// to deallocate once Write returns.
///
@@ -635,6 +638,7 @@ class ServerAsyncReaderInterface
/// This operation will end when the server has finished sending out initial
/// metadata (if not sent already), response message, and status, or if
/// some failure occurred when trying to do so.
+ ///
/// GRPC doesn't take ownership or a reference to \a msg or \a status, so it
/// is safe to to deallocate once Finish returns.
///