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 * Abstract interface for an RPC channel. An {@code RpcChannel} represents a communication line to a 35 * {@link Service} which can be used to call that {@link Service}'s methods. The {@link Service} may 36 * be running on another machine. Normally, you should not call an {@code RpcChannel} directly, but 37 * instead construct a stub {@link Service} wrapping it. Example: 38 * 39 * <pre> 40 * RpcChannel channel = rpcImpl.newChannel("remotehost.example.com:1234"); 41 * RpcController controller = rpcImpl.newController(); 42 * MyService service = MyService.newStub(channel); 43 * service.myMethod(controller, request, callback); 44 * </pre> 45 * 46 * <p>Starting with version 2.3.0, RPC implementations should not try to build on this, but should 47 * instead provide code generator plugins which generate code specific to the particular RPC 48 * implementation. This way the generated code can be more appropriate for the implementation in use 49 * and can avoid unnecessary layers of indirection. 50 * 51 * @author kenton@google.com Kenton Varda 52 */ 53 public interface RpcChannel { 54 /** 55 * Call the given method of the remote service. This method is similar to {@code 56 * Service.callMethod()} with one important difference: the caller decides the types of the {@code 57 * Message} objects, not the callee. The request may be of any type as long as {@code 58 * request.getDescriptor() == method.getInputType()}. The response passed to the callback will be 59 * of the same type as {@code responsePrototype} (which must have {@code getDescriptor() == 60 * method.getOutputType()}). 61 */ callMethod( Descriptors.MethodDescriptor method, RpcController controller, Message request, Message responsePrototype, RpcCallback<Message> done)62 void callMethod( 63 Descriptors.MethodDescriptor method, 64 RpcController controller, 65 Message request, 66 Message responsePrototype, 67 RpcCallback<Message> done); 68 } 69