java/src/main/java/com/google/protobuf/BlockingService.java

   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
  31 package com.google.protobuf;
  32
  33 /**
  34  * Blocking equivalent to {@link Service}.
  35  *
  36  * @author kenton@google.com Kenton Varda
  37  * @author cpovirk@google.com Chris Povirk
  38  */
  39 public interface BlockingService {
  40   /**
  41    * Equivalent to {@link Service#getDescriptorForType}.
  42    */
  43   Descriptors.ServiceDescriptor getDescriptorForType();
  44
  45   /**
  46    * Equivalent to {@link Service#callMethod}, except that
  47    * {@code callBlockingMethod()} returns the result of the RPC or throws a
  48    * {@link ServiceException} if there is a failure, rather than passing the
  49    * information to a callback.
  50    */
  51   Message callBlockingMethod(Descriptors.MethodDescriptor method,
  52                              RpcController controller,
  53                              Message request) throws ServiceException;
  54
  55   /**
  56    * Equivalent to {@link Service#getRequestPrototype}.
  57    */
  58   Message getRequestPrototype(Descriptors.MethodDescriptor method);
  59
  60   /**
  61    * Equivalent to {@link Service#getResponsePrototype}.
  62    */
  63   Message getResponsePrototype(Descriptors.MethodDescriptor method);
  64 }