java_service.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__
  34. #define GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__
  35. #include <map>
  36. #include <google/protobuf/descriptor.h>
  37. namespace google {
  38. namespace protobuf {
  39. namespace compiler {
  40. namespace java {
  41. class Context; // context.h
  42. class ClassNameResolver; // name_resolver.h
  43. }
  44. }
  45. namespace io {
  46. class Printer; // printer.h
  47. }
  48. }
  49. namespace protobuf {
  50. namespace compiler {
  51. namespace java {
  52. class ServiceGenerator {
  53. public:
  54. explicit ServiceGenerator(const ServiceDescriptor* descriptor);
  55. virtual ~ServiceGenerator();
  56. virtual void Generate(io::Printer* printer) = 0;
  57. enum RequestOrResponse { REQUEST, RESPONSE };
  58. enum IsAbstract { IS_ABSTRACT, IS_CONCRETE };
  59. protected:
  60. const ServiceDescriptor* descriptor_;
  61. private:
  62. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator);
  63. };
  64. class ImmutableServiceGenerator : public ServiceGenerator {
  65. public:
  66. ImmutableServiceGenerator(const ServiceDescriptor* descriptor,
  67. Context* context);
  68. virtual ~ImmutableServiceGenerator();
  69. virtual void Generate(io::Printer* printer);
  70. private:
  71. // Generate the getDescriptorForType() method.
  72. void GenerateGetDescriptorForType(io::Printer* printer);
  73. // Generate a Java interface for the service.
  74. void GenerateInterface(io::Printer* printer);
  75. // Generate newReflectiveService() method.
  76. void GenerateNewReflectiveServiceMethod(io::Printer* printer);
  77. // Generate newReflectiveBlockingService() method.
  78. void GenerateNewReflectiveBlockingServiceMethod(io::Printer* printer);
  79. // Generate abstract method declarations for all methods.
  80. void GenerateAbstractMethods(io::Printer* printer);
  81. // Generate the implementation of Service.callMethod().
  82. void GenerateCallMethod(io::Printer* printer);
  83. // Generate the implementation of BlockingService.callBlockingMethod().
  84. void GenerateCallBlockingMethod(io::Printer* printer);
  85. // Generate the implementations of Service.get{Request,Response}Prototype().
  86. void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer);
  87. // Generate a stub implementation of the service.
  88. void GenerateStub(io::Printer* printer);
  89. // Generate a method signature, possibly abstract, without body or trailing
  90. // semicolon.
  91. void GenerateMethodSignature(io::Printer* printer,
  92. const MethodDescriptor* method,
  93. IsAbstract is_abstract);
  94. // Generate a blocking stub interface and implementation of the service.
  95. void GenerateBlockingStub(io::Printer* printer);
  96. // Generate the method signature for one method of a blocking stub.
  97. void GenerateBlockingMethodSignature(io::Printer* printer,
  98. const MethodDescriptor* method);
  99. // Return the output type of the method.
  100. string GetOutput(const MethodDescriptor* method);
  101. Context* context_;
  102. ClassNameResolver* name_resolver_;
  103. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableServiceGenerator);
  104. };
  105. } // namespace java
  106. } // namespace compiler
  107. } // namespace protobuf
  108. #endif // NET_PROTO2_COMPILER_JAVA_SERVICE_H__
  109. } // namespace google