legacy-libs/grpc/deps/grpc/src/core/ext/filters/client_channel/client_channel_channelz.h

   1 /*
   2  *
   3  * Copyright 2018 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_CLIENT_CHANNEL_CHANNELZ_H
  20 #define GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_CLIENT_CHANNEL_CHANNELZ_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include "src/core/lib/channel/channel_args.h"
  25 #include "src/core/lib/channel/channel_stack.h"
  26 #include "src/core/lib/channel/channel_trace.h"
  27 #include "src/core/lib/channel/channelz.h"
  28
  29 namespace grpc_core {
  30
  31 class Subchannel;
  32
  33 namespace channelz {
  34
  35 class SubchannelNode : public BaseNode {
  36  public:
  37   SubchannelNode(const char* target_address, size_t channel_tracer_max_nodes);
  38   ~SubchannelNode() override;
  39
  40   // Sets the subchannel's connectivity state without health checking.
  41   void UpdateConnectivityState(grpc_connectivity_state state);
  42
  43   // Used when the subchannel's child socket changes. This should be set when
  44   // the subchannel's transport is created and set to nullptr when the
  45   // subchannel unrefs the transport.
  46   void SetChildSocket(RefCountedPtr<SocketNode> socket);
  47
  48   grpc_json* RenderJson() override;
  49
  50   // proxy methods to composed classes.
  51   void AddTraceEvent(ChannelTrace::Severity severity, const grpc_slice& data) {
  52     trace_.AddTraceEvent(severity, data);
  53   }
  54   void AddTraceEventWithReference(ChannelTrace::Severity severity,
  55                                   const grpc_slice& data,
  56                                   RefCountedPtr<BaseNode> referenced_channel) {
  57     trace_.AddTraceEventWithReference(severity, data,
  58                                       std::move(referenced_channel));
  59   }
  60   void RecordCallStarted() { call_counter_.RecordCallStarted(); }
  61   void RecordCallFailed() { call_counter_.RecordCallFailed(); }
  62   void RecordCallSucceeded() { call_counter_.RecordCallSucceeded(); }
  63
  64  private:
  65   void PopulateConnectivityState(grpc_json* json);
  66
  67   Atomic<grpc_connectivity_state> connectivity_state_{GRPC_CHANNEL_IDLE};
  68   Mutex socket_mu_;
  69   RefCountedPtr<SocketNode> child_socket_;
  70   UniquePtr<char> target_;
  71   CallCountingHelper call_counter_;
  72   ChannelTrace trace_;
  73 };
  74
  75 }  // namespace channelz
  76 }  // namespace grpc_core
  77
  78 #endif /* GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_CLIENT_CHANNEL_CHANNELZ_H */