client_context.h 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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. /// A ClientContext allows the person implementing a service client to:
  19. ///
  20. /// - Add custom metadata key-value pairs that will propagated to the server
  21. /// side.
  22. /// - Control call settings such as compression and authentication.
  23. /// - Initial and trailing metadata coming from the server.
  24. /// - Get performance metrics (ie, census).
  25. ///
  26. /// Context settings are only relevant to the call they are invoked with, that
  27. /// is to say, they aren't sticky. Some of these settings, such as the
  28. /// compression options, can be made persistent at channel construction time
  29. /// (see \a grpc::CreateCustomChannel).
  30. ///
  31. /// \warning ClientContext instances should \em not be reused across rpcs.
  32. #ifndef GRPCPP_CLIENT_CONTEXT_H
  33. #define GRPCPP_CLIENT_CONTEXT_H
  34. #include <grpcpp/impl/codegen/client_context.h> // IWYU pragma: export
  35. #endif // GRPCPP_CLIENT_CONTEXT_H