GRPC C++  1.13.0-dev
Public Member Functions | Friends
grpc::Channel Class Referencefinal

Channels represent a connection to an endpoint. Created by CreateChannel. More...

#include <channel.h>

Public Member Functions

 ~Channel ()
 
grpc_connectivity_state GetState (bool try_to_connect) override
 Get the current channel state. More...
 
grpc::string GetLoadBalancingPolicyName () const
 Returns the LB policy name, or the empty string if not yet available. More...
 
grpc::string GetServiceConfigJSON () const
 Returns the service config in JSON form, or the empty string if not available. More...
 
- Public Member Functions inherited from grpc::ChannelInterface
virtual ~ChannelInterface ()
 
template<typename T >
void NotifyOnStateChange (grpc_connectivity_state last_observed, T deadline, 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...
 
- Public Member Functions inherited from grpc::internal::CallHook
virtual ~CallHook ()
 

Friends

template<class InputMessage , class OutputMessage >
class internal::BlockingUnaryCallImpl
 
std::shared_ptr< ChannelCreateChannelInternal (const grpc::string &host, grpc_channel *c_channel)
 

Detailed Description

Channels represent a connection to an endpoint. Created by CreateChannel.

Constructor & Destructor Documentation

◆ ~Channel()

grpc::Channel::~Channel ( )

Member Function Documentation

◆ GetLoadBalancingPolicyName()

grpc::string grpc::Channel::GetLoadBalancingPolicyName ( ) const

Returns the LB policy name, or the empty string if not yet available.

◆ GetServiceConfigJSON()

grpc::string grpc::Channel::GetServiceConfigJSON ( ) const

Returns the service config in JSON form, or the empty string if not available.

◆ GetState()

grpc_connectivity_state grpc::Channel::GetState ( bool  try_to_connect)
overridevirtual

Get the current channel state.

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

Implements grpc::ChannelInterface.

Friends And Related Function Documentation

◆ CreateChannelInternal

std::shared_ptr<Channel> CreateChannelInternal ( const grpc::string host,
grpc_channel c_channel 
)
friend

◆ internal::BlockingUnaryCallImpl

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

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