legacy-libs/grpc/deps/grpc/src/core/ext/filters/client_channel/local_subchannel_pool.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_LOCAL_SUBCHANNEL_POOL_H
  20 #define GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_LOCAL_SUBCHANNEL_POOL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include "src/core/ext/filters/client_channel/subchannel_pool_interface.h"
  25
  26 namespace grpc_core {
  27
  28 // The local subchannel pool that is owned by a single channel. It doesn't
  29 // support subchannel sharing with other channels by nature. Nor does it support
  30 // subchannel retention when a subchannel is not used. The only real purpose of
  31 // using this subchannel pool is to allow subchannel reuse within the channel
  32 // when an incoming resolver update contains some addresses for which the
  33 // channel has already created subchannels.
  34 // Thread-unsafe.
  35 class LocalSubchannelPool final : public SubchannelPoolInterface {
  36  public:
  37   LocalSubchannelPool();
  38   ~LocalSubchannelPool() override;
  39
  40   // Implements interface methods.
  41   // Thread-unsafe. Intended to be invoked within the client_channel combiner.
  42   Subchannel* RegisterSubchannel(SubchannelKey* key,
  43                                  Subchannel* constructed) override;
  44   void UnregisterSubchannel(SubchannelKey* key) override;
  45   Subchannel* FindSubchannel(SubchannelKey* key) override;
  46
  47  private:
  48   // The vtable for subchannel operations in an AVL tree.
  49   static const grpc_avl_vtable subchannel_avl_vtable_;
  50   // A map from subchannel key to subchannel.
  51   grpc_avl subchannel_map_;
  52 };
  53
  54 }  // namespace grpc_core
  55
  56 #endif /* GRPC_CORE_EXT_FILTERS_CLIENT_CHANNEL_LOCAL_SUBCHANNEL_POOL_H */