diff --git a/core/src/main/java/io/grpc/ClientCall.java b/core/src/main/java/io/grpc/ClientCall.java index e081c42a68..5735bb006b 100644 --- a/core/src/main/java/io/grpc/ClientCall.java +++ b/core/src/main/java/io/grpc/ClientCall.java @@ -63,7 +63,7 @@ public abstract class ClientCall { public abstract static class Listener { /** - * The response headers have been received. Headers always precede payloads. + * The response headers have been received. Headers always precede messages. * This method is always called, if no headers were received then an empty {@link Metadata} * is passed. * @@ -75,9 +75,23 @@ public abstract class ClientCall { * A response payload has been received. May be called zero or more times depending on whether * the call response is empty, a single message or a stream of messages. * - * @param payload returned by the server + * @param payload returned by the server + * @deprecated use {@link #onMessage} */ - public abstract void onPayload(T payload); + @Deprecated + public void onPayload(T payload) { + throw new UnsupportedOperationException(); + } + + /** + * A response message has been received. May be called zero or more times depending on whether + * the call response is empty, a single message or a stream of messages. + * + * @param message returned by the server + */ + public void onMessage(T message) { + onPayload(message); + } /** * The ClientCall has been closed. Any additional calls to the {@code ClientCall} will not be @@ -113,7 +127,7 @@ public abstract class ClientCall { /** * Requests up to the given number of messages from the call to be delivered to - * {@link Listener#onPayload(Object)}. No additional messages will be delivered. + * {@link Listener#onMessage(Object)}. No additional messages will be delivered. * *

Message delivery is guaranteed to be sequential in the order received. In addition, the * listener methods will not be accessed concurrently. While it is not guaranteed that the same diff --git a/core/src/main/java/io/grpc/ClientCallImpl.java b/core/src/main/java/io/grpc/ClientCallImpl.java index 9b0085d279..f6d143b5d4 100644 --- a/core/src/main/java/io/grpc/ClientCallImpl.java +++ b/core/src/main/java/io/grpc/ClientCallImpl.java @@ -253,7 +253,7 @@ final class ClientCallImpl extends ClientCall { } try { - observer.onPayload(method.parseResponse(message)); + observer.onMessage(method.parseResponse(message)); } finally { message.close(); } diff --git a/core/src/main/java/io/grpc/ForwardingClientCallListener.java b/core/src/main/java/io/grpc/ForwardingClientCallListener.java index b7da41fd45..b92ab1e133 100644 --- a/core/src/main/java/io/grpc/ForwardingClientCallListener.java +++ b/core/src/main/java/io/grpc/ForwardingClientCallListener.java @@ -47,8 +47,8 @@ public abstract class ForwardingClientCallListener extends ClientCall.Lis } @Override - public void onPayload(RespT payload) { - delegate().onPayload(payload); + public void onMessage(RespT message) { + delegate().onMessage(message); } @Override diff --git a/interop-testing/src/main/java/io/grpc/testing/integration/AbstractTransportTest.java b/interop-testing/src/main/java/io/grpc/testing/integration/AbstractTransportTest.java index 1f08571390..4b35c2e1b5 100644 --- a/interop-testing/src/main/java/io/grpc/testing/integration/AbstractTransportTest.java +++ b/interop-testing/src/main/java/io/grpc/testing/integration/AbstractTransportTest.java @@ -449,8 +449,8 @@ public abstract class AbstractTransportTest { public void onHeaders(Metadata.Headers headers) {} @Override - public void onPayload(final StreamingOutputCallResponse payload) { - queue.add(payload); + public void onMessage(final StreamingOutputCallResponse message) { + queue.add(message); } @Override diff --git a/stub/src/main/java/io/grpc/stub/ClientCalls.java b/stub/src/main/java/io/grpc/stub/ClientCalls.java index be484d18c5..b1a4be3540 100644 --- a/stub/src/main/java/io/grpc/stub/ClientCalls.java +++ b/stub/src/main/java/io/grpc/stub/ClientCalls.java @@ -241,14 +241,14 @@ public class ClientCalls { } @Override - public void onPayload(RespT payload) { + public void onMessage(RespT message) { if (firstResponseReceived && !streamingResponse) { throw Status.INTERNAL .withDescription("More than one responses received for unary or client-streaming call") .asRuntimeException(); } firstResponseReceived = true; - observer.onValue(payload); + observer.onValue(message); if (streamingResponse) { // Request delivery of the next inbound message. @@ -282,7 +282,7 @@ public class ClientCalls { } @Override - public void onPayload(RespT value) { + public void onMessage(RespT value) { if (this.value != null) { throw Status.INTERNAL.withDescription("More than one value received for unary call") .asRuntimeException(); @@ -397,7 +397,7 @@ public class ClientCalls { } @Override - public void onPayload(T value) { + public void onMessage(T value) { Preconditions.checkState(!done, "ClientCall already closed"); buffer.add(value); } diff --git a/stub/src/test/java/io/grpc/stub/ClientCallsTest.java b/stub/src/test/java/io/grpc/stub/ClientCallsTest.java index 46d89efbe4..492c0a5db8 100644 --- a/stub/src/test/java/io/grpc/stub/ClientCallsTest.java +++ b/stub/src/test/java/io/grpc/stub/ClientCallsTest.java @@ -73,7 +73,7 @@ public class ClientCallsTest { ClientCall.Listener listener = listenerCaptor.getValue(); verify(call).sendPayload(req); verify(call).halfClose(); - listener.onPayload("bar"); + listener.onMessage("bar"); listener.onClose(Status.OK, new Metadata.Trailers()); assertEquals("bar", future.get()); } @@ -102,7 +102,7 @@ public class ClientCallsTest { ClientCall.Listener listener = listenerCaptor.getValue(); future.cancel(true); verify(call).cancel(); - listener.onPayload("bar"); + listener.onMessage("bar"); listener.onClose(Status.OK, new Metadata.Trailers()); try { future.get();