channel_impl.h

Go to the documentation of this file.

/*
 *
 * Copyright 2015 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#ifndef GRPCPP_CHANNEL_IMPL_H
#define GRPCPP_CHANNEL_IMPL_H
 
#include <memory>
 
#include <grpc/grpc.h>
#include <grpcpp/impl/call.h>
#include <grpcpp/impl/codegen/channel_interface.h>
#include <grpcpp/impl/codegen/client_interceptor.h>
#include <grpcpp/impl/codegen/completion_queue_impl.h>
#include <grpcpp/impl/codegen/config.h>
#include <grpcpp/impl/codegen/grpc_library.h>
#include <grpcpp/impl/codegen/sync.h>
 
struct grpc_channel;
 
namespace grpc {
namespace testing {
class ChannelTestPeer;
}  // namespace testing
 
std::shared_ptr<::grpc_impl::Channel> CreateChannelInternal(
    const grpc::string& host, grpc_channel* c_channel,
    std::vector<
        std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>
        interceptor_creators);
}  // namespace grpc
namespace grpc_impl {
 
namespace experimental {
void ChannelResetConnectionBackoff(Channel* channel);
}  // namespace experimental
 
class Channel final : public ::grpc::ChannelInterface,
                      public ::grpc::internal::CallHook,
                      public std::enable_shared_from_this<Channel>,
                      private ::grpc::GrpcLibraryCodegen {
 public:
  ~Channel();
 
  grpc_connectivity_state GetState(bool try_to_connect) override;
 
  grpc::string GetLoadBalancingPolicyName() const;
 
  grpc::string GetServiceConfigJSON() const;
 
 private:
  template <class InputMessage, class OutputMessage>
  friend class ::grpc::internal::BlockingUnaryCallImpl;
  friend class ::grpc::testing::ChannelTestPeer;
  friend void experimental::ChannelResetConnectionBackoff(Channel* channel);
  friend std::shared_ptr<Channel> grpc::CreateChannelInternal(
      const grpc::string& host, grpc_channel* c_channel,
      std::vector<std::unique_ptr<
          ::grpc::experimental::ClientInterceptorFactoryInterface>>
          interceptor_creators);
  friend class ::grpc::internal::InterceptedChannel;
  Channel(const grpc::string& host, grpc_channel* c_channel,
          std::vector<std::unique_ptr<
              ::grpc::experimental::ClientInterceptorFactoryInterface>>
              interceptor_creators);
 
  ::grpc::internal::Call CreateCall(const ::grpc::internal::RpcMethod& method,
                                    ::grpc_impl::ClientContext* context,
                                    ::grpc_impl::CompletionQueue* cq) override;
  void PerformOpsOnCall(::grpc::internal::CallOpSetInterface* ops,
                        ::grpc::internal::Call* call) override;
  void* RegisterMethod(const char* method) override;
 
  void NotifyOnStateChangeImpl(grpc_connectivity_state last_observed,
                               gpr_timespec deadline,
                               ::grpc_impl::CompletionQueue* cq,
                               void* tag) override;
  bool WaitForStateChangeImpl(grpc_connectivity_state last_observed,
                              gpr_timespec deadline) override;
 
  ::grpc_impl::CompletionQueue* CallbackCQ() override;
 
  ::grpc::internal::Call CreateCallInternal(
      const ::grpc::internal::RpcMethod& method,
      ::grpc_impl::ClientContext* context, ::grpc_impl::CompletionQueue* cq,
      size_t interceptor_pos) override;
 
  const grpc::string host_;
  grpc_channel* const c_channel_;  // owned
 
  // mu_ protects callback_cq_ (the per-channel callbackable completion queue)
  grpc::internal::Mutex mu_;
 
  // callback_cq_ references the callbackable completion queue associated
  // with this channel (if any). It is set on the first call to CallbackCQ().
  // It is _not owned_ by the channel; ownership belongs with its internal
  // shutdown callback tag (invoked when the CQ is fully shutdown).
  ::grpc_impl::CompletionQueue* callback_cq_ = nullptr;
 
  std::vector<
      std::unique_ptr<::grpc::experimental::ClientInterceptorFactoryInterface>>
      interceptor_creators_;
};
 
}  // namespace grpc_impl
 
#endif  // GRPCPP_CHANNEL_IMPL_H