src/third_party/protobuf/src/google/protobuf/compiler/java/java_service.h

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // http://code.google.com/p/protobuf/
   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
  31 // Author: kenton@google.com (Kenton Varda)
  32 //  Based on original Protocol Buffers design by
  33 //  Sanjay Ghemawat, Jeff Dean, and others.
  34
  35 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__
  36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__
  37
  38 #include <map>
  39 #include <google/protobuf/descriptor.h>
  40
  41 namespace google {
  42 namespace protobuf {
  43   namespace io {
  44     class Printer;             // printer.h
  45   }
  46 }
  47
  48 namespace protobuf {
  49 namespace compiler {
  50 namespace java {
  51
  52 class ServiceGenerator {
  53  public:
  54   explicit ServiceGenerator(const ServiceDescriptor* descriptor);
  55   ~ServiceGenerator();
  56
  57   void Generate(io::Printer* printer);
  58
  59  private:
  60
  61   // Generate the getDescriptorForType() method.
  62   void GenerateGetDescriptorForType(io::Printer* printer);
  63
  64   // Generate a Java interface for the service.
  65   void GenerateInterface(io::Printer* printer);
  66
  67   // Generate newReflectiveService() method.
  68   void GenerateNewReflectiveServiceMethod(io::Printer* printer);
  69
  70   // Generate newReflectiveBlockingService() method.
  71   void GenerateNewReflectiveBlockingServiceMethod(io::Printer* printer);
  72
  73   // Generate abstract method declarations for all methods.
  74   void GenerateAbstractMethods(io::Printer* printer);
  75
  76   // Generate the implementation of Service.callMethod().
  77   void GenerateCallMethod(io::Printer* printer);
  78
  79   // Generate the implementation of BlockingService.callBlockingMethod().
  80   void GenerateCallBlockingMethod(io::Printer* printer);
  81
  82   // Generate the implementations of Service.get{Request,Response}Prototype().
  83   enum RequestOrResponse { REQUEST, RESPONSE };
  84   void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer);
  85
  86   // Generate a stub implementation of the service.
  87   void GenerateStub(io::Printer* printer);
  88
  89   // Generate a method signature, possibly abstract, without body or trailing
  90   // semicolon.
  91   enum IsAbstract { IS_ABSTRACT, IS_CONCRETE };
  92   void GenerateMethodSignature(io::Printer* printer,
  93                                const MethodDescriptor* method,
  94                                IsAbstract is_abstract);
  95
  96   // Generate a blocking stub interface and implementation of the service.
  97   void GenerateBlockingStub(io::Printer* printer);
  98
  99   // Generate the method signature for one method of a blocking stub.
 100   void GenerateBlockingMethodSignature(io::Printer* printer,
 101                                        const MethodDescriptor* method);
 102
 103   const ServiceDescriptor* descriptor_;
 104
 105   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator);
 106 };
 107
 108 }  // namespace java
 109 }  // namespace compiler
 110 }  // namespace protobuf
 111
 112 #endif  // NET_PROTO2_COMPILER_JAVA_SERVICE_H__
 113 }  // namespace google