aboutsummaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2017-05-19 13:16:13 -0700
committerGravatar Mark D. Roth <roth@google.com>2017-05-19 13:16:13 -0700
commit127fdaeace0bd1715ae4e6b8ece6bd838d766819 (patch)
tree737bca677bd42f6acde3a1268ffef9317145abb3 /include
parentaf3cc761adfd06b7620b77d70e87640b7a341ba1 (diff)
More Doxygen comment improvements.
Diffstat (limited to 'include')
-rw-r--r--include/grpc++/create_channel.h14
-rw-r--r--include/grpc++/impl/codegen/client_context.h5
-rw-r--r--include/grpc++/security/auth_metadata_processor.h3
-rw-r--r--include/grpc++/server.h2
-rw-r--r--include/grpc++/server_builder.h8
5 files changed, 22 insertions, 10 deletions
diff --git a/include/grpc++/create_channel.h b/include/grpc++/create_channel.h
index 0537695ed2..11f9bc037c 100644
--- a/include/grpc++/create_channel.h
+++ b/include/grpc++/create_channel.h
@@ -43,23 +43,25 @@
namespace grpc {
-/// Create a new \a Channel pointing to \a target
+/// Create a new \a Channel pointing to \a target.
///
/// \param target The URI of the endpoint to connect to.
-/// \param creds Credentials to use for the created channel. If it does not hold
-/// an object or is invalid, a lame channel is returned.
+/// \param creds Credentials to use for the created channel. If it does not
+/// hold an object or is invalid, a lame channel (one on which all operations
+/// fail) is returned.
std::shared_ptr<Channel> CreateChannel(
const grpc::string& target,
const std::shared_ptr<ChannelCredentials>& creds);
-/// Create a new \em custom \a Channel pointing to \a target
+/// Create a new \em custom \a Channel pointing to \a target.
///
/// \warning For advanced use and testing ONLY. Override default channel
/// arguments only if necessary.
///
/// \param target The URI of the endpoint to connect to.
-/// \param creds Credentials to use for the created channel. If it does not hold
-/// an object or is invalid, a lame channel is returned.
+/// \param creds Credentials to use for the created channel. If it does not
+/// hold an object or is invalid, a lame channel (one on which all operations
+/// fail) is returned.
/// \param args Options for channel creation.
std::shared_ptr<Channel> CreateCustomChannel(
const grpc::string& target,
diff --git a/include/grpc++/impl/codegen/client_context.h b/include/grpc++/impl/codegen/client_context.h
index b1b9be0fe2..720df8a1dc 100644
--- a/include/grpc++/impl/codegen/client_context.h
+++ b/include/grpc++/impl/codegen/client_context.h
@@ -331,8 +331,9 @@ class ClientContext {
return census_context_;
}
- /// Send a best-effort out-of-band cancel. The call could be in any stage.
- /// e.g. if it is already finished, it may still return success.
+ /// Send a best-effort out-of-band cancel on the call associated with
+ /// this client context. The call could be in any stage; e.g., if it is
+ /// already finished, it may still return success.
///
/// There is no guarantee the call will be cancelled.
void TryCancel();
diff --git a/include/grpc++/security/auth_metadata_processor.h b/include/grpc++/security/auth_metadata_processor.h
index 3536923146..9d3d41a7a0 100644
--- a/include/grpc++/security/auth_metadata_processor.h
+++ b/include/grpc++/security/auth_metadata_processor.h
@@ -42,6 +42,9 @@
namespace grpc {
+/// Interface allowing custom server-side authorization based on credentials
+/// encoded in metadata. Objects of this type can be passed to
+/// \a ServerCredentials::SetAuthMetadataProcessor().
class AuthMetadataProcessor {
public:
typedef std::multimap<grpc::string_ref, grpc::string_ref> InputMetadata;
diff --git a/include/grpc++/server.h b/include/grpc++/server.h
index 2f7018e95b..976879c9c5 100644
--- a/include/grpc++/server.h
+++ b/include/grpc++/server.h
@@ -67,7 +67,7 @@ class Server final : public ServerInterface, private GrpcLibraryCodegen {
public:
~Server();
- /// Block waiting for all work to complete.
+ /// Block until the server shuts down.
///
/// \warning The server must be either shutting down or some other thread must
/// call \a Shutdown for this function to ever return.
diff --git a/include/grpc++/server_builder.h b/include/grpc++/server_builder.h
index 2185b283ac..84ec2eb6ed 100644
--- a/include/grpc++/server_builder.h
+++ b/include/grpc++/server_builder.h
@@ -71,7 +71,13 @@ class ServerBuilder {
ServerBuilder();
~ServerBuilder();
- enum SyncServerOption { NUM_CQS, MIN_POLLERS, MAX_POLLERS, CQ_TIMEOUT_MSEC };
+ /// Options for synchronous servers.
+ enum SyncServerOption {
+ NUM_CQS, // Number of completion queues.
+ MIN_POLLERS, // Minimum number of polling threads.
+ MAX_POLLERS, // Maximum number of polling threads.
+ CQ_TIMEOUT_MSEC // Completion queue timeout in milliseconds.
+ };
/// Register a service. This call does not take ownership of the service.
/// The service must exist for the lifetime of the \a Server instance returned