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 /// \mainpage gRPC C++ API 20 /// 21 /// The gRPC C++ API mainly consists of the following classes: 22 /// <br> 23 /// - grpc::Channel, which represents the connection to an endpoint. See [the 24 /// gRPC Concepts page](https://grpc.io/docs/what-is-grpc/core-concepts) for 25 /// more details. Channels are created by the factory function 26 /// grpc::CreateChannel. 27 /// 28 /// - grpc::CompletionQueue, the producer-consumer queue used for all 29 /// asynchronous communication with the gRPC runtime. 30 /// 31 /// - grpc::ClientContext and grpc::ServerContext, where optional configuration 32 /// for an RPC can be set, such as setting custom metadata to be conveyed to the 33 /// peer, compression settings, authentication, etc. 34 /// 35 /// - grpc::Server, representing a gRPC server, created by grpc::ServerBuilder. 36 /// 37 /// Streaming calls are handled with the streaming classes in 38 /// \ref sync_stream.h and 39 /// \ref async_stream.h. 40 /// 41 /// Refer to the 42 /// [examples](https://github.com/grpc/grpc/blob/master/examples/cpp) 43 /// for code putting these pieces into play. 44 45 #ifndef GRPCPP_GRPCPP_H 46 #define GRPCPP_GRPCPP_H 47 48 // Pragma for http://include-what-you-use.org/ tool, tells that following 49 // headers are not private for grpcpp.h and are part of its interface. 50 // IWYU pragma: begin_exports 51 #include <grpc/grpc.h> 52 #include <grpcpp/channel.h> 53 #include <grpcpp/client_context.h> 54 #include <grpcpp/completion_queue.h> 55 #include <grpcpp/create_channel.h> 56 #include <grpcpp/create_channel_posix.h> 57 #include <grpcpp/server.h> 58 #include <grpcpp/server_builder.h> 59 #include <grpcpp/server_context.h> 60 #include <grpcpp/server_posix.h> 61 #include <grpcpp/version_info.h> 62 // IWYU pragma: end_exports 63 64 namespace grpc { 65 /// Return gRPC library version. 66 std::string Version(); 67 } // namespace grpc 68 69 #endif // GRPCPP_GRPCPP_H 70