Public Types | Public Member Functions | List of all members
grpc_core::LoadBalancingPolicy::ChannelControlHelper Class Referenceabstract

#include <lb_policy.h>

Inheritance diagram for grpc_core::LoadBalancingPolicy::ChannelControlHelper:
Inheritance graph
[legend]

Public Types

enum  TraceSeverity { TRACE_INFO, TRACE_WARNING, TRACE_ERROR }
 Adds a trace message associated with the channel. More...
 

Public Member Functions

virtual void AddTraceEvent (TraceSeverity severity, absl::string_view message)=0
 
 ChannelControlHelper ()=default
 
virtual RefCountedPtr< SubchannelInterfaceCreateSubchannel (ServerAddress address, const grpc_channel_args &args)=0
 Creates a new subchannel with the specified channel args. More...
 
virtual absl::string_view GetAuthority ()=0
 Returns the channel authority. More...
 
virtual void RequestReresolution ()=0
 Requests that the resolver re-resolve. More...
 
virtual void UpdateState (grpc_connectivity_state state, const absl::Status &status, std::unique_ptr< SubchannelPicker >)=0
 
virtual ~ChannelControlHelper ()=default
 

Detailed Description

A proxy object implemented by the client channel and used by the LB policy to communicate with the channel.

Definition at line 275 of file lb_policy.h.

Member Enumeration Documentation

◆ TraceSeverity

Adds a trace message associated with the channel.

Enumerator
TRACE_INFO 
TRACE_WARNING 
TRACE_ERROR 

Definition at line 297 of file lb_policy.h.

Constructor & Destructor Documentation

◆ ChannelControlHelper()

grpc_core::LoadBalancingPolicy::ChannelControlHelper::ChannelControlHelper ( )
default

◆ ~ChannelControlHelper()

virtual grpc_core::LoadBalancingPolicy::ChannelControlHelper::~ChannelControlHelper ( )
virtualdefault

Member Function Documentation

◆ AddTraceEvent()

virtual void grpc_core::LoadBalancingPolicy::ChannelControlHelper::AddTraceEvent ( TraceSeverity  severity,
absl::string_view  message 
)
pure virtual

◆ CreateSubchannel()

virtual RefCountedPtr<SubchannelInterface> grpc_core::LoadBalancingPolicy::ChannelControlHelper::CreateSubchannel ( ServerAddress  address,
const grpc_channel_args args 
)
pure virtual

Creates a new subchannel with the specified channel args.

Implemented in grpc_core::ClientChannel::ClientChannelControlHelper, and grpc_core::ChildPolicyHandler::Helper.

◆ GetAuthority()

virtual absl::string_view grpc_core::LoadBalancingPolicy::ChannelControlHelper::GetAuthority ( )
pure virtual

◆ RequestReresolution()

virtual void grpc_core::LoadBalancingPolicy::ChannelControlHelper::RequestReresolution ( )
pure virtual

Requests that the resolver re-resolve.

Implemented in grpc_core::ClientChannel::ClientChannelControlHelper, and grpc_core::ChildPolicyHandler::Helper.

◆ UpdateState()

virtual void grpc_core::LoadBalancingPolicy::ChannelControlHelper::UpdateState ( grpc_connectivity_state  state,
const absl::Status status,
std::unique_ptr< SubchannelPicker  
)
pure virtual

Sets the connectivity state and returns a new picker to be used by the client channel.

Implemented in grpc_core::ChildPolicyHandler::Helper, and grpc_core::ClientChannel::ClientChannelControlHelper.


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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:36