GRPC C++ 0.10.0.0

- Main Page
- Namespaces
- Data Structures
- Files

- File List
- Globals

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
channel_arguments.h
Go to the documentation of this file.
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_CHANNEL_ARGUMENTS_H
35 #define GRPCXX_CHANNEL_ARGUMENTS_H
36
37 #include <vector>
38 #include <list>
39
40 #include <grpc++/config.h>
41 #include <grpc/compression.h>
42 #include <grpc/grpc.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 ChannelArguments() {}
55 ~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 // grpc specific channel argument setters
66 // Set target name override for SSL host name checking.
67 void SetSslTargetNameOverride(const grpc::string& name);
68 // TODO(yangg) add flow control options
69
70 // Set the compression algorithm for the channel.
71 void SetCompressionAlgorithm(grpc_compression_algorithm algorithm);
72
73 // Generic channel argument setters. Only for advanced use cases.
74 void SetInt(const grpc::string& key, int value);
75 void SetString(const grpc::string& key, const grpc::string& value);
76
77 // Populates given channel_args with args_, does not take ownership.
78 void SetChannelArgs(grpc_channel_args* channel_args) const;
79
80 private:
81 friend class SecureCredentials;
82 friend class testing::ChannelArgumentsTest;
83
84 // Returns empty string when it is not set.
85 grpc::string GetSslTargetNameOverride() const;
86
87 std::vector<grpc_arg> args_;
88 std::list<grpc::string> strings_;
89 };
90
91 } // namespace grpc
92
93 #endif // GRPCXX_CHANNEL_ARGUMENTS_H
grpc::ChannelArguments::SecureCredentials
friend class SecureCredentials
Definition: channel_arguments.h:81
grpc::ChannelArguments::ChannelArgumentsTest
friend class testing::ChannelArgumentsTest
Definition: channel_arguments.h:82
grpc::string
std::string string
Definition: config.h:112
grpc::ChannelArguments::SetString
void SetString(const grpc::string &key, const grpc::string &value)
grpc::ChannelArguments
Definition: channel_arguments.h:52
config.h
grpc::ChannelArguments::Swap
void Swap(ChannelArguments &other)
grpc::ChannelArguments::SetCompressionAlgorithm
void SetCompressionAlgorithm(grpc_compression_algorithm algorithm)
grpc::ChannelArguments::SetSslTargetNameOverride
void SetSslTargetNameOverride(const grpc::string &name)
grpc::ChannelArguments::~ChannelArguments
~ChannelArguments()
Definition: channel_arguments.h:55
grpc::ChannelArguments::SetInt
void SetInt(const grpc::string &key, int value)
grpc::ChannelArguments::operator=
ChannelArguments & operator=(ChannelArguments other)
Definition: channel_arguments.h:58
grpc::ChannelArguments::ChannelArguments
ChannelArguments()
Definition: channel_arguments.h:54
grpc::ChannelArguments::SetChannelArgs
void SetChannelArgs(grpc_channel_args *channel_args) const