Line data    Source code

       1             : /*
       2             :  *
       3             :  * Copyright 2015, Google Inc.
       4             :  * All rights reserved.
       5             :  *
       6             :  * Redistribution and use in source and binary forms, with or without
       7             :  * modification, are permitted provided that the following conditions are
       8             :  * met:
       9             :  *
      10             :  *     * Redistributions of source code must retain the above copyright
      11             :  * notice, this list of conditions and the following disclaimer.
      12             :  *     * Redistributions in binary form must reproduce the above
      13             :  * copyright notice, this list of conditions and the following disclaimer
      14             :  * in the documentation and/or other materials provided with the
      15             :  * distribution.
      16             :  *     * Neither the name of Google Inc. nor the names of its
      17             :  * contributors may be used to endorse or promote products derived from
      18             :  * this software without specific prior written permission.
      19             :  *
      20             :  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
      21             :  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
      22             :  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
      23             :  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
      24             :  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
      25             :  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
      26             :  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
      27             :  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      28             :  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
      29             :  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
      30             :  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
      31             :  *
      32             :  */
      33             : 
      34             : #ifndef GRPCXX_SUPPORT_CHANNEL_ARGUMENTS_H
      35             : #define GRPCXX_SUPPORT_CHANNEL_ARGUMENTS_H
      36             : 
      37             : #include <vector>
      38             : #include <list>
      39             : 
      40             : #include <grpc/compression.h>
      41             : #include <grpc/grpc.h>
      42             : #include <grpc++/support/config.h>
      43             : 
      44             : namespace grpc {
      45             : namespace testing {
      46             : class ChannelArgumentsTest;
      47             : }  // namespace testing
      48             : 
      49             : /// Options for channel creation. The user can use generic setters to pass
      50             : /// key value pairs down to c channel creation code. For grpc related options,
      51             : /// concrete setters are provided.
      52             : class ChannelArguments {
      53             :  public:
      54         208 :   ChannelArguments() {}
      55         390 :   ~ChannelArguments() {}
      56             : 
      57             :   ChannelArguments(const ChannelArguments& other);
      58             :   ChannelArguments& operator=(ChannelArguments other) {
      59             :     Swap(other);
      60             :     return *this;
      61             :   }
      62             : 
      63             :   void Swap(ChannelArguments& other);
      64             : 
      65             :   /// Populates this instance with the arguments from \a channel_args. Does not
      66             :   /// take ownership of \a channel_args.
      67             :   ///
      68             :   /// Note that the underlying arguments are shared. Changes made to either \a
      69             :   /// channel_args or this instance would be reflected on both.
      70             :   void SetChannelArgs(grpc_channel_args* channel_args) const;
      71             : 
      72             :   // gRPC specific channel argument setters
      73             :   /// Set target name override for SSL host name checking.
      74             :   void SetSslTargetNameOverride(const grpc::string& name);
      75             :   // TODO(yangg) add flow control options
      76             :   /// Set the compression algorithm for the channel.
      77             :   void SetCompressionAlgorithm(grpc_compression_algorithm algorithm);
      78             : 
      79             :   // Generic channel argument setters. Only for advanced use cases.
      80             :   /// Set an integer argument \a value under \a key.
      81             :   void SetInt(const grpc::string& key, int value);
      82             :   /// Set a textual argument \a value under \a key.
      83             :   void SetString(const grpc::string& key, const grpc::string& value);
      84             : 
      85             :  private:
      86             :   friend class SecureCredentials;
      87             :   friend class testing::ChannelArgumentsTest;
      88             : 
      89             :   // Returns empty string when it is not set.
      90             :   grpc::string GetSslTargetNameOverride() const;
      91             : 
      92             :   std::vector<grpc_arg> args_;
      93             :   std::list<grpc::string> strings_;
      94             : };
      95             : 
      96             : }  // namespace grpc
      97             : 
      98             : #endif  // GRPCXX_SUPPORT_CHANNEL_ARGUMENTS_H