aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc++/server.h
diff options
context:
space:
mode:
authorGravatar Mehrdad Afshari <mmx@google.com>2017-05-05 10:38:49 -0700
committerGravatar Mehrdad Afshari <mehrdad@afshari.me>2017-05-17 23:30:07 -0700
commit3cd6cf4983a5b9f5f713c76041535a0bfce4b99f (patch)
tree54bba92d35072420026a2b2b10b936ea56f6dcbc /include/grpc++/server.h
parentbcd6ca5033c501a92c6d1f2037b41b2c35579a93 (diff)
Fix documentation for Server::AddListeningPort
Clarify that Port is actually an endpoint. Fix typos Clarify that it should be used before starting the server.
Diffstat (limited to 'include/grpc++/server.h')
-rw-r--r--include/grpc++/server.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/include/grpc++/server.h b/include/grpc++/server.h
index 1d9f5ac041..ac89b8ca4f 100644
--- a/include/grpc++/server.h
+++ b/include/grpc++/server.h
@@ -163,15 +163,17 @@ class Server final : public ServerInterface, private GrpcLibraryCodegen {
/// service. The service must exist for the lifetime of the Server instance.
void RegisterAsyncGenericService(AsyncGenericService* service) override;
- /// Tries to bind \a server to the given \a addr.
+ /// Try binding the server to the given \a addr endpoint
+ /// (port, and optionally including IP address to bind to).
///
- /// It can be invoked multiple times.
+ /// It can be invoked multiple times. Should be used before
+ /// starting the server.
///
/// \param addr The address to try to bind to the server (eg, localhost:1234,
/// 192.168.1.1:31416, [::1]:27182, etc.).
/// \params creds The credentials associated with the server.
///
- /// \return bound port number on sucess, 0 on failure.
+ /// \return bound port number on success, 0 on failure.
///
/// \warning It's an error to call this method on an already started server.
int AddListeningPort(const grpc::string& addr,