diff options
author | 2017-05-11 14:23:53 -0700 | |
---|---|---|
committer | 2017-05-11 15:15:29 -0700 | |
commit | bb2c338924c128fb84f224d2531f4c24fa7da241 (patch) | |
tree | aa7afe0540281ad295d97679da660dab2d6dbfb7 /include/grpc++/impl/codegen | |
parent | d6ba5ecc343479f8a0508f3ea322fafe162d0290 (diff) |
format changes, address comments
Diffstat (limited to 'include/grpc++/impl/codegen')
-rw-r--r-- | include/grpc++/impl/codegen/async_stream.h | 10 | ||||
-rw-r--r-- | include/grpc++/impl/codegen/async_unary_call.h | 2 | ||||
-rw-r--r-- | include/grpc++/impl/codegen/client_context.h | 6 | ||||
-rw-r--r-- | include/grpc++/impl/codegen/server_context.h | 14 | ||||
-rw-r--r-- | include/grpc++/impl/codegen/status_code_enum.h | 2 | ||||
-rw-r--r-- | include/grpc++/impl/codegen/sync_stream.h | 3 |
6 files changed, 18 insertions, 19 deletions
diff --git a/include/grpc++/impl/codegen/async_stream.h b/include/grpc++/impl/codegen/async_stream.h index 3402fff38b..04fc5241cb 100644 --- a/include/grpc++/impl/codegen/async_stream.h +++ b/include/grpc++/impl/codegen/async_stream.h @@ -70,9 +70,8 @@ class ClientAsyncStreamingInterface { /// \a ClientAsyncReaderWriterInterface::WritesDone). /// * there are no more messages to be received from the server (this can /// be known implicitly by the calling code, or explicitly from an - /// earlier call to \a AsyncReaderInterface::Read that - /// yielded a failed result - /// , e.g. cq->Next(&read_tag, &ok) filled in 'ok' with 'false'). + /// earlier call to \a AsyncReaderInterface::Read that yielded a failed + /// result, e.g. cq->Next(&read_tag, &ok) filled in 'ok' with 'false'). /// /// This function will return when either: /// - all incoming messages have been read and the server has returned @@ -814,9 +813,8 @@ class ServerAsyncReaderWriterInterface : public ServerAsyncStreamingInterface, /// * it is desired to end the call early with some non-OK status code. /// /// 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. + /// metadata (if not sent already), response message, and status, or if some + /// failure occurred when trying to do so. /// /// \param[in] tag Tag identifying this request. /// \param[in] status To be sent to the client as the result of this call. diff --git a/include/grpc++/impl/codegen/async_unary_call.h b/include/grpc++/impl/codegen/async_unary_call.h index 0f2f466bfc..aadf77d8a8 100644 --- a/include/grpc++/impl/codegen/async_unary_call.h +++ b/include/grpc++/impl/codegen/async_unary_call.h @@ -47,6 +47,8 @@ namespace grpc { class CompletionQueue; extern CoreCodegenInterface* g_core_codegen_interface; +/// An interface relevant for async client side unary RPCS (which send +/// one request message to a server and receive one response message). template <class R> class ClientAsyncResponseReaderInterface { public: diff --git a/include/grpc++/impl/codegen/client_context.h b/include/grpc++/impl/codegen/client_context.h index 1653887289..b1b9be0fe2 100644 --- a/include/grpc++/impl/codegen/client_context.h +++ b/include/grpc++/impl/codegen/client_context.h @@ -192,8 +192,8 @@ class ClientContext { /// /// \param meta_key The metadata key. If \a meta_value is binary data, it must /// end in "-bin". - /// \param meta_value The metadata value. If its value is binary, it must be - /// end in "-bin". + /// \param meta_value The metadata value. If its value is binary, the key name + /// must end in "-bin". void AddMetadata(const grpc::string& meta_key, const grpc::string& meta_value); @@ -249,7 +249,7 @@ class ClientContext { /// EXPERIMENTAL: Trigger wait-for-ready or not on this request. /// See https://github.com/grpc/grpc/blob/master/doc/wait-for-ready.md. - /// If set, if an RPC made when a channel's connectivity state is + /// If set, if an RPC is made when a channel's connectivity state is /// TRANSIENT_FAILURE or CONNECTING, the call will not "fail fast", /// and the channel will wait until the channel is READY before making the /// call. diff --git a/include/grpc++/impl/codegen/server_context.h b/include/grpc++/impl/codegen/server_context.h index 42575176d7..bd52434c54 100644 --- a/include/grpc++/impl/codegen/server_context.h +++ b/include/grpc++/impl/codegen/server_context.h @@ -127,10 +127,10 @@ class ServerContext { /// to the client (which can happen explicitly, or implicitly when sending a /// a response message or status to the client). /// - /// \param meta_key The metadata key. If \a meta_value is binary data, - /// it must end in "-bin". - /// \param meta_value The metadata value. If its value is binary, - /// it must be must end in "-bin". + /// \param meta_key The metadata key. If \a meta_value is binary data, it must + /// end in "-bin". + /// \param meta_value The metadata value. If its value is binary, the key name + /// must end in "-bin". void AddInitialMetadata(const grpc::string& key, const grpc::string& value); /// Add the (\a meta_key, \a meta_value) pair to the initial metadata @@ -143,8 +143,8 @@ class ServerContext { /// /// \param meta_key The metadata key. If \a meta_value is binary data, /// it must end in "-bin". - /// \param meta_value The metadata value. If its value is binary, - /// it must be end in "-bin". + /// \param meta_value The metadata value. If its value is binary, the key name + /// must end in "-bin". void AddTrailingMetadata(const grpc::string& key, const grpc::string& value); /// IsCancelled is always safe to call when using sync API. @@ -153,7 +153,7 @@ class ServerContext { bool IsCancelled() const; /// Cancel the Call from the server. This is a best-effort API and - /// depending :on when it is called, the RPC may still appear successful to + /// depending on when it is called, the RPC may still appear successful to /// the client. /// For example, if TryCancel() is called on a separate thread, it might race /// with the server handler which might return success to the client before diff --git a/include/grpc++/impl/codegen/status_code_enum.h b/include/grpc++/impl/codegen/status_code_enum.h index a60cdef60e..c3d27fa3b0 100644 --- a/include/grpc++/impl/codegen/status_code_enum.h +++ b/include/grpc++/impl/codegen/status_code_enum.h @@ -136,7 +136,7 @@ enum StatusCode { /// The service is currently unavailable. This is a most likely a transient /// condition and may be corrected by retrying with a backoff. /// - /// \warning: Although data MIGHT not have been transmitted when this + /// \warning Although data MIGHT not have been transmitted when this /// status occurs, there is NOT A GUARANTEE that the server has not seen /// anything. So in general it is unsafe to retry on this status code /// if the call is non-idempotent. diff --git a/include/grpc++/impl/codegen/sync_stream.h b/include/grpc++/impl/codegen/sync_stream.h index e7d9b07c19..db9048d7e5 100644 --- a/include/grpc++/impl/codegen/sync_stream.h +++ b/include/grpc++/impl/codegen/sync_stream.h @@ -222,8 +222,7 @@ class ClientReader final : public ClientReaderInterface<R> { /// Side effect: /// This also receives initial metadata from the server, if not /// already received (if initial metadata is received, it can be then - /// accessed - /// through the \a ClientContext associated with this call). + /// accessed through the \a ClientContext associated with this call). bool Read(R* msg) override { CallOpSet<CallOpRecvInitialMetadata, CallOpRecvMessage<R>> ops; if (!context_->initial_metadata_received_) { |