diff options
| author |  Mehrdad Afshari <mmx@google.com> | 2017-05-05 11:04:42 -0700 |
|---|---|---|
| committer |  Mehrdad Afshari <mehrdad@afshari.me> | 2017-05-17 23:30:08 -0700 |
| commit | 3475cf72c8d65dea7e2a4694b1f059d5a39824d2 (patch) | |
| tree | 8e2d91c954c62babf2a7efc48f598d0f432d5495 /include/grpc++/server_builder.h | |
| parent | 32abe8a6c2e959445faff6a85c7eb003c3d22dec (diff) | |
Corrected the documentation for ServerBuilder::AddListenPort
Diffstat (limited to 'include/grpc++/server_builder.h')
| -rw-r--r-- | include/grpc++/server_builder.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/include/grpc++/server_builder.h b/include/grpc++/server_builder.h index 2185b283ac..c5b5cb4a48 100644 --- a/include/grpc++/server_builder.h +++ b/include/grpc++/server_builder.h @@ -139,15 +139,17 @@ class ServerBuilder { return SetOption(MakeChannelArgumentOption(arg, value)); } - /// Tries to bind \a server to the given \a addr. + /// Enlists an endpoint \a addr (port with an optional IP address) to + /// bind the \a grpc::Server object to be created to. /// /// It can be invoked multiple times. /// /// \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. - /// \param selected_port[out] Upon success, updated to contain the port - /// number. \a nullptr otherwise. + /// \param selected_port[out] If not `nullptr`, gets populated with the port + /// number bound to the \a grpc::Server for the corresponding endpoint after + /// it is successfully bound, 0 otherwise. /// // TODO(dgq): the "port" part seems to be a misnomer. ServerBuilder& AddListeningPort(const grpc::string& addr, |