/thirdparty/breakpad/third_party/protobuf/protobuf/java/src/main/java/com/google/protobuf/RpcChannel.java

http://github.com/tomahawk-player/tomahawk · Java · 71 lines · 8 code · 2 blank · 61 comment · 0 complexity · 80a41269db8be89ce8001b5fab2d31ed MD5 · raw file

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