Skip to content
Snippets Groups Projects
Commit 127fdaea authored by Mark D. Roth's avatar Mark D. Roth
Browse files

More Doxygen comment improvements.

parent af3cc761
Branches
Tags
No related merge requests found
...@@ -43,23 +43,25 @@ ...@@ -43,23 +43,25 @@
namespace grpc { 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 target The URI of the endpoint to connect to.
/// \param creds Credentials to use for the created channel. If it does not hold /// \param creds Credentials to use for the created channel. If it does not
/// an object or is invalid, a lame channel is returned. /// hold an object or is invalid, a lame channel (one on which all operations
/// fail) is returned.
std::shared_ptr<Channel> CreateChannel( std::shared_ptr<Channel> CreateChannel(
const grpc::string& target, const grpc::string& target,
const std::shared_ptr<ChannelCredentials>& creds); 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 /// \warning For advanced use and testing ONLY. Override default channel
/// arguments only if necessary. /// arguments only if necessary.
/// ///
/// \param target The URI of the endpoint to connect to. /// \param target The URI of the endpoint to connect to.
/// \param creds Credentials to use for the created channel. If it does not hold /// \param creds Credentials to use for the created channel. If it does not
/// an object or is invalid, a lame channel is returned. /// hold an object or is invalid, a lame channel (one on which all operations
/// fail) is returned.
/// \param args Options for channel creation. /// \param args Options for channel creation.
std::shared_ptr<Channel> CreateCustomChannel( std::shared_ptr<Channel> CreateCustomChannel(
const grpc::string& target, const grpc::string& target,
... ...
......
...@@ -331,8 +331,9 @@ class ClientContext { ...@@ -331,8 +331,9 @@ class ClientContext {
return census_context_; return census_context_;
} }
/// Send a best-effort out-of-band cancel. The call could be in any stage. /// Send a best-effort out-of-band cancel on the call associated with
/// e.g. if it is already finished, it may still return success. /// 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. /// There is no guarantee the call will be cancelled.
void TryCancel(); void TryCancel();
... ...
......
...@@ -42,6 +42,9 @@ ...@@ -42,6 +42,9 @@
namespace grpc { 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 { class AuthMetadataProcessor {
public: public:
typedef std::multimap<grpc::string_ref, grpc::string_ref> InputMetadata; typedef std::multimap<grpc::string_ref, grpc::string_ref> InputMetadata;
... ...
......
...@@ -67,7 +67,7 @@ class Server final : public ServerInterface, private GrpcLibraryCodegen { ...@@ -67,7 +67,7 @@ class Server final : public ServerInterface, private GrpcLibraryCodegen {
public: public:
~Server(); ~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 /// \warning The server must be either shutting down or some other thread must
/// call \a Shutdown for this function to ever return. /// call \a Shutdown for this function to ever return.
... ...
......
...@@ -71,7 +71,13 @@ class ServerBuilder { ...@@ -71,7 +71,13 @@ class ServerBuilder {
ServerBuilder(); 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. /// 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 /// The service must exist for the lifetime of the \a Server instance returned
... ...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment