grpc::ChannelInterface Class Reference

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::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::ClientReader
template<class W >
class	grpc::ClientWriter
template<class W , class R >
class	grpc::ClientReaderWriter
template<class R >
class	grpc::internal::ClientAsyncReaderFactory
template<class W >
class	grpc::internal::ClientAsyncWriterFactory
template<class W , class R >
class	grpc::internal::ClientAsyncReaderWriterFactory
class	grpc::internal::ClientAsyncResponseReaderHelper
template<class W , class R >
class	grpc::internal::ClientCallbackReaderWriterFactory
template<class R >
class	grpc::internal::ClientCallbackReaderFactory
template<class W >
class	grpc::internal::ClientCallbackWriterFactory
class	grpc::internal::ClientCallbackUnaryFactory
template<class InputMessage , class OutputMessage >
class	grpc::internal::BlockingUnaryCallImpl
template<class InputMessage , class OutputMessage >
class	grpc::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::Channel, grpc::internal::InterceptedChannel, and grpc::experimental::DelegatingChannel.

NotifyOnStateChange()

template<typename T >

void grpc::ChannelInterface::NotifyOnStateChange ( grpc_connectivity_state  last_observed, T  deadline, grpc::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 ( T  deadline )

inline

Wait for this channel to be connected.

WaitForStateChange()

template<typename T >

bool grpc::ChannelInterface::WaitForStateChange ( grpc_connectivity_state  last_observed, T  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::ClientReader

template<class R >

friend class grpc::ClientReader

friend

grpc::ClientReaderWriter

template<class W , class R >

friend class grpc::ClientReaderWriter

friend

grpc::ClientWriter

template<class W >

friend class grpc::ClientWriter

friend

grpc::experimental::DelegatingChannel

friend class grpc::experimental::DelegatingChannel

friend

grpc::internal::BlockingUnaryCallImpl

template<class InputMessage , class OutputMessage >

friend class grpc::internal::BlockingUnaryCallImpl

friend

grpc::internal::CallbackUnaryCallImpl

template<class InputMessage , class OutputMessage >

friend class grpc::internal::CallbackUnaryCallImpl

friend

grpc::internal::ClientAsyncReaderFactory

template<class R >

friend class grpc::internal::ClientAsyncReaderFactory

friend

grpc::internal::ClientAsyncReaderWriterFactory

template<class W , class R >

friend class grpc::internal::ClientAsyncReaderWriterFactory

friend

grpc::internal::ClientAsyncResponseReaderHelper

friend class grpc::internal::ClientAsyncResponseReaderHelper

friend

grpc::internal::ClientAsyncWriterFactory

template<class W >

friend class grpc::internal::ClientAsyncWriterFactory

friend

grpc::internal::ClientCallbackReaderFactory

template<class R >

friend class grpc::internal::ClientCallbackReaderFactory

friend

grpc::internal::ClientCallbackReaderWriterFactory

template<class W , class R >

friend class grpc::internal::ClientCallbackReaderWriterFactory

friend

grpc::internal::ClientCallbackUnaryFactory

friend class grpc::internal::ClientCallbackUnaryFactory

friend

grpc::internal::ClientCallbackWriterFactory

template<class W >

friend class grpc::internal::ClientCallbackWriterFactory

friend

grpc::internal::InterceptedChannel

friend class grpc::internal::InterceptedChannel

friend

grpc::internal::RpcMethod

friend class grpc::internal::RpcMethod

friend

---

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

• include/grpcpp/impl/channel_interface.h