io.grpc.stub.ClientResponseObserver Maven / Gradle / Ivy
/*
* Copyright 2016 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.grpc.stub;
/**
* Specialization of {@link StreamObserver} implemented by clients in order to interact with the
* advanced features of a call such as flow-control.
*/
public interface ClientResponseObserver extends StreamObserver {
/**
* Called by the runtime prior to the start of a call to provide a reference to the
* {@link ClientCallStreamObserver} for the outbound stream. This can be used to listen to
* onReady events, disable auto inbound flow and perform other advanced functions.
*
* Only the methods {@link ClientCallStreamObserver#setOnReadyHandler(Runnable)} and
* {@link ClientCallStreamObserver#disableAutoRequestWithInitial(int)} may be called within
* this callback
*
*
* // Copy an iterator to the request stream under flow-control
* someStub.fullDuplexCall(new ClientResponseObserver<ReqT, RespT>() {
* public void beforeStart(final ClientCallStreamObserver<Req> requestStream) {
* StreamObservers.copyWithFlowControl(someIterator, requestStream);
* });
*
*/
void beforeStart(final ClientCallStreamObserver requestStream);
}