GRPC C++  1.24.0
Public Member Functions | Friends
grpc::ChannelInterface Class Referenceabstract

Codegen interface for grpc::Channel. More...

#include <channel_interface.h>

Public Member Functions

virtual ~ChannelInterface ()
 
virtual grpc_connectivity_state GetState (bool try_to_connect)=0
 Get the current channel state. More...
 
template<typename T >
void NotifyOnStateChange (grpc_connectivity_state last_observed, T deadline, ::grpc_impl::CompletionQueue *cq, void *tag)
 Return the tag on cq when the channel state is changed or deadline expires. More...
 
template<typename T >
bool WaitForStateChange (grpc_connectivity_state last_observed, T deadline)
 Blocking wait for channel state change or deadline expiration. More...
 
template<typename T >
bool WaitForConnected (T deadline)
 Wait for this channel to be connected. More...
 

Friends

template<class R >
class ::grpc_impl::ClientReader
 
template<class W >
class ::grpc_impl::ClientWriter
 
template<class W , class R >
class ::grpc_impl::ClientReaderWriter
 
template<class R >
class ::grpc_impl::internal::ClientAsyncReaderFactory
 
template<class W >
class ::grpc_impl::internal::ClientAsyncWriterFactory
 
template<class W , class R >
class ::grpc_impl::internal::ClientAsyncReaderWriterFactory
 
template<class R >
class ::grpc_impl::internal::ClientAsyncResponseReaderFactory
 
template<class W , class R >
class ::grpc_impl::internal::ClientCallbackReaderWriterFactory
 
template<class R >
class ::grpc_impl::internal::ClientCallbackReaderFactory
 
template<class W >
class ::grpc_impl::internal::ClientCallbackWriterFactory
 
class ::grpc_impl::internal::ClientCallbackUnaryFactory
 
template<class InputMessage , class OutputMessage >
class ::grpc::internal::BlockingUnaryCallImpl
 
template<class InputMessage , class OutputMessage >
class ::grpc_impl::internal::CallbackUnaryCallImpl
 
class ::grpc::internal::RpcMethod
 
class ::grpc::experimental::DelegatingChannel
 
class ::grpc::internal::InterceptedChannel
 

Detailed Description

Codegen interface for grpc::Channel.

Constructor & Destructor Documentation

◆ ~ChannelInterface()

virtual grpc::ChannelInterface::~ChannelInterface ( )
inlinevirtual

Member Function Documentation

◆ GetState()

virtual grpc_connectivity_state grpc::ChannelInterface::GetState ( bool  try_to_connect)
pure virtual

Get the current channel state.

If the channel is in IDLE and try_to_connect is set to true, try to connect.

Implemented in grpc_impl::Channel, grpc::internal::InterceptedChannel, and grpc::experimental::DelegatingChannel.

◆ NotifyOnStateChange()

template<typename T >
void grpc::ChannelInterface::NotifyOnStateChange ( grpc_connectivity_state  last_observed,
deadline,
::grpc_impl::CompletionQueue cq,
void *  tag 
)
inline

Return the tag on cq when the channel state is changed or deadline expires.

GetState needs to called to get the current state.

◆ WaitForConnected()

template<typename T >
bool grpc::ChannelInterface::WaitForConnected ( deadline)
inline

Wait for this channel to be connected.

◆ WaitForStateChange()

template<typename T >
bool grpc::ChannelInterface::WaitForStateChange ( grpc_connectivity_state  last_observed,
deadline 
)
inline

Blocking wait for channel state change or deadline expiration.

GetState needs to called to get the current state.

Friends And Related Function Documentation

◆ ::grpc::experimental::DelegatingChannel

◆ ::grpc::internal::BlockingUnaryCallImpl

template<class InputMessage , class OutputMessage >
friend class ::grpc::internal::BlockingUnaryCallImpl
friend

◆ ::grpc::internal::InterceptedChannel

friend class ::grpc::internal::InterceptedChannel
friend

◆ ::grpc::internal::RpcMethod

friend class ::grpc::internal::RpcMethod
friend

◆ ::grpc_impl::ClientReader

template<class R >
friend class ::grpc_impl::ClientReader
friend

◆ ::grpc_impl::ClientReaderWriter

template<class W , class R >
friend class ::grpc_impl::ClientReaderWriter
friend

◆ ::grpc_impl::ClientWriter

template<class W >
friend class ::grpc_impl::ClientWriter
friend

◆ ::grpc_impl::internal::CallbackUnaryCallImpl

template<class InputMessage , class OutputMessage >
friend class ::grpc_impl::internal::CallbackUnaryCallImpl
friend

◆ ::grpc_impl::internal::ClientAsyncReaderFactory

template<class R >
friend class ::grpc_impl::internal::ClientAsyncReaderFactory
friend

◆ ::grpc_impl::internal::ClientAsyncReaderWriterFactory

template<class W , class R >
friend class ::grpc_impl::internal::ClientAsyncReaderWriterFactory
friend

◆ ::grpc_impl::internal::ClientAsyncResponseReaderFactory

template<class R >
friend class ::grpc_impl::internal::ClientAsyncResponseReaderFactory
friend

◆ ::grpc_impl::internal::ClientAsyncWriterFactory

template<class W >
friend class ::grpc_impl::internal::ClientAsyncWriterFactory
friend

◆ ::grpc_impl::internal::ClientCallbackReaderFactory

template<class R >
friend class ::grpc_impl::internal::ClientCallbackReaderFactory
friend

◆ ::grpc_impl::internal::ClientCallbackReaderWriterFactory

template<class W , class R >
friend class ::grpc_impl::internal::ClientCallbackReaderWriterFactory
friend

◆ ::grpc_impl::internal::ClientCallbackUnaryFactory

◆ ::grpc_impl::internal::ClientCallbackWriterFactory

template<class W >
friend class ::grpc_impl::internal::ClientCallbackWriterFactory
friend

The documentation for this class was generated from the following file: