1fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Protocol Buffers - Google's data interchange format 2fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Copyright 2008 Google Inc. All rights reserved. 3fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// http://code.google.com/p/protobuf/ 4fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 5fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Redistribution and use in source and binary forms, with or without 6fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// modification, are permitted provided that the following conditions are 7fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// met: 8fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 9fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions of source code must retain the above copyright 10fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// notice, this list of conditions and the following disclaimer. 11fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions in binary form must reproduce the above 12fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// copyright notice, this list of conditions and the following disclaimer 13fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// in the documentation and/or other materials provided with the 14fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// distribution. 15fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Neither the name of Google Inc. nor the names of its 16fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// contributors may be used to endorse or promote products derived from 17fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// this software without specific prior written permission. 18fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 19fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 31fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillepackage com.google.protobuf; 32fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville/** 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * <p>Abstract interface for an RPC channel. An {@code RpcChannel} represents a 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * communication line to a {@link Service} which can be used to call that 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * {@link Service}'s methods. The {@link Service} may be running on another 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * machine. Normally, you should not call an {@code RpcChannel} directly, but 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * instead construct a stub {@link Service} wrapping it. Example: 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * <pre> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * RpcChannel channel = rpcImpl.newChannel("remotehost.example.com:1234"); 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * RpcController controller = rpcImpl.newController(); 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * MyService service = MyService.newStub(channel); 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * service.myMethod(controller, request, callback); 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * </pre> 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * 47d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * <p>Starting with version 2.3.0, RPC implementations should not try to build 48d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * on this, but should instead provide code generator plugins which generate 49d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * code specific to the particular RPC implementation. This way the generated 50d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * code can be more appropriate for the implementation in use and can avoid 51d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * unnecessary layers of indirection. 52d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville * 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * @author kenton@google.com Kenton Varda 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville */ 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillepublic interface RpcChannel { 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville /** 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * Call the given method of the remote service. This method is similar to 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * {@code Service.callMethod()} with one important difference: the caller 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * decides the types of the {@code Message} objects, not the callee. The 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * request may be of any type as long as 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * {@code request.getDescriptor() == method.getInputType()}. 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * The response passed to the callback will be of the same type as 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * {@code responsePrototype} (which must have 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville * {@code getDescriptor() == method.getOutputType()}). 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville */ 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void callMethod(Descriptors.MethodDescriptor method, 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville RpcController controller, 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Message request, 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Message responsePrototype, 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville RpcCallback<Message> done); 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 72