Public Types | Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
grpc_core::channelz::BaseNode Class Referenceabstract

#include <channelz.h>

Inheritance diagram for grpc_core::channelz::BaseNode:
Inheritance graph
[legend]

Public Types

enum  EntityType {
  EntityType::kTopLevelChannel, EntityType::kInternalChannel, EntityType::kSubchannel, EntityType::kServer,
  EntityType::kSocket
}
 
- Public Types inherited from grpc_core::RefCounted< BaseNode >
using RefCountedChildType = BaseNode
 

Public Member Functions

const std::string & name () const
 
virtual Json RenderJson ()=0
 
std::string RenderJsonString ()
 
EntityType type () const
 
intptr_t uuid () const
 
 ~BaseNode () override
 
- Public Member Functions inherited from grpc_core::RefCounted< BaseNode >
RefCountedoperator= (const RefCounted &)=delete
 
RefCountedPtr< BaseNode > Ref () GRPC_MUST_USE_RESULT
 
RefCountedPtr< BaseNode > Ref (const DebugLocation &location, const char *reason) GRPC_MUST_USE_RESULT
 
 RefCounted (const RefCounted &)=delete
 
RefCountedPtr< BaseNode > RefIfNonZero () GRPC_MUST_USE_RESULT
 
RefCountedPtr< BaseNode > RefIfNonZero (const DebugLocation &location, const char *reason) GRPC_MUST_USE_RESULT
 
void Unref ()
 
void Unref (const DebugLocation &location, const char *reason)
 
 ~RefCounted ()=default
 
- Public Member Functions inherited from grpc_core::PolymorphicRefCount
virtual ~PolymorphicRefCount ()=default
 

Protected Member Functions

 BaseNode (EntityType type, std::string name)
 
- Protected Member Functions inherited from grpc_core::RefCounted< BaseNode >
 RefCounted (const char *trace=nullptr, intptr_t initial_refcount=1)
 

Private Attributes

std::string name_
 
const EntityType type_
 
intptr_t uuid_
 

Friends

class ChannelzRegistry
 

Detailed Description

Definition at line 78 of file channelz.h.

Member Enumeration Documentation

◆ EntityType

Enumerator
kTopLevelChannel 
kInternalChannel 
kSubchannel 
kServer 
kSocket 

Definition at line 83 of file channelz.h.

Constructor & Destructor Documentation

◆ BaseNode()

grpc_core::channelz::BaseNode::BaseNode ( EntityType  type,
std::string  name 
)
protected

Definition at line 59 of file src/core/lib/channel/channelz.cc.

◆ ~BaseNode()

grpc_core::channelz::BaseNode::~BaseNode ( )
override

Definition at line 65 of file src/core/lib/channel/channelz.cc.

Member Function Documentation

◆ name()

const std::string& grpc_core::channelz::BaseNode::name ( ) const
inline

Definition at line 106 of file channelz.h.

◆ RenderJson()

virtual Json grpc_core::channelz::BaseNode::RenderJson ( )
pure virtual

◆ RenderJsonString()

std::string grpc_core::channelz::BaseNode::RenderJsonString ( )

Definition at line 67 of file src/core/lib/channel/channelz.cc.

◆ type()

EntityType grpc_core::channelz::BaseNode::type ( ) const
inline

Definition at line 104 of file channelz.h.

◆ uuid()

intptr_t grpc_core::channelz::BaseNode::uuid ( ) const
inline

Definition at line 105 of file channelz.h.

Friends And Related Function Documentation

◆ ChannelzRegistry

friend class ChannelzRegistry
friend

Definition at line 110 of file channelz.h.

Member Data Documentation

◆ name_

std::string grpc_core::channelz::BaseNode::name_
private

Definition at line 113 of file channelz.h.

◆ type_

const EntityType grpc_core::channelz::BaseNode::type_
private

Definition at line 111 of file channelz.h.

◆ uuid_

intptr_t grpc_core::channelz::BaseNode::uuid_
private

Definition at line 112 of file channelz.h.


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


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