• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *
3  * Copyright 2015 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 GRPCPP_CREATE_CHANNEL_H
20 #define GRPCPP_CREATE_CHANNEL_H
21 
22 #include <memory>
23 
24 #include <grpcpp/channel.h>
25 #include <grpcpp/security/credentials.h>
26 #include <grpcpp/support/channel_arguments.h>
27 #include <grpcpp/support/config.h>
28 
29 namespace grpc {
30 
31 /// Create a new \a Channel pointing to \a target.
32 ///
33 /// \param target The URI of the endpoint to connect to.
34 /// \param creds Credentials to use for the created channel. If it does not
35 /// hold an object or is invalid, a lame channel (one on which all operations
36 /// fail) is returned.
37 std::shared_ptr<Channel> CreateChannel(
38     const grpc::string& target,
39     const std::shared_ptr<ChannelCredentials>& creds);
40 
41 /// Create a new \em custom \a Channel pointing to \a target.
42 ///
43 /// \warning For advanced use and testing ONLY. Override default channel
44 /// arguments only if necessary.
45 ///
46 /// \param target The URI of the endpoint to connect to.
47 /// \param creds Credentials to use for the created channel. If it does not
48 /// hold an object or is invalid, a lame channel (one on which all operations
49 /// fail) is returned.
50 /// \param args Options for channel creation.
51 std::shared_ptr<Channel> CreateCustomChannel(
52     const grpc::string& target,
53     const std::shared_ptr<ChannelCredentials>& creds,
54     const ChannelArguments& args);
55 
56 }  // namespace grpc
57 
58 #endif  // GRPCPP_CREATE_CHANNEL_H
59