diff options
author | Craig Tiller <ctiller@google.com> | 2015-09-03 09:37:02 -0700 |
---|---|---|
committer | Craig Tiller <ctiller@google.com> | 2015-09-03 09:37:02 -0700 |
commit | d6599a39e48b152eeb1b55d427fbe5f22817b663 (patch) | |
tree | fdf2f1466f394008aebd93ee6e5dc18d6d9049c0 /include/grpc++/channel.h | |
parent | aca3211b0f41aa862a424327de6d3a36e455a3c4 (diff) |
Replicate C++ docs from master to beta branch
Original PR #3074 by @dgquintas
Diffstat (limited to 'include/grpc++/channel.h')
-rw-r--r-- | include/grpc++/channel.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/include/grpc++/channel.h b/include/grpc++/channel.h index a8af74175b..60c816d58a 100644 --- a/include/grpc++/channel.h +++ b/include/grpc++/channel.h @@ -65,18 +65,19 @@ class ClientAsyncReaderWriter; template <class R> class ClientAsyncResponseReader; +/// Channels represent a connection to an endpoint. Created by \a CreateChannel. class Channel GRPC_FINAL : public GrpcLibrary, public CallHook, public std::enable_shared_from_this<Channel> { public: ~Channel(); - // Get the current channel state. If the channel is in IDLE and try_to_connect - // is set to true, try to connect. + /// Get the current channel state. If the channel is in IDLE and + /// \a try_to_connect is set to true, try to connect. grpc_connectivity_state GetState(bool try_to_connect); - // Return the tag on cq when the channel state is changed or deadline expires. - // GetState needs to called to get the current state. + /// Return the \a tag on \a cq when the channel state is changed or \a + /// deadline expires. \a GetState needs to called to get the current state. template <typename T> void NotifyOnStateChange(grpc_connectivity_state last_observed, T deadline, CompletionQueue* cq, void* tag) { @@ -84,8 +85,8 @@ class Channel GRPC_FINAL : public GrpcLibrary, NotifyOnStateChangeImpl(last_observed, deadline_tp.raw_time(), cq, tag); } - // Blocking wait for channel state change or deadline expiration. - // GetState needs to called to get the current state. + /// Blocking wait for channel state change or \a deadline expiration. + /// \a GetState needs to called to get the current state. template <typename T> bool WaitForStateChange(grpc_connectivity_state last_observed, T deadline) { TimePoint<T> deadline_tp(deadline); |