io.grpc.internal.ServerStreamListener Maven / Gradle / Ivy
/*
* Copyright 2014, gRPC Authors All rights reserved.
*
* 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.internal;
import io.grpc.Status;
/** An observer of server-side stream events. */
public interface ServerStreamListener extends StreamListener {
/**
* Called when the remote side of the transport gracefully closed, indicating the client had no
* more data to send. No further messages will be received on the stream.
*
* This method should return quickly, as the same thread may be used to process other streams.
*/
void halfClosed();
/**
* Called when the stream is fully closed. A status code of {@link
* io.grpc.Status.Code#OK} implies normal termination of the stream.
* Any other value implies abnormal termination. Since clients cannot send status, the passed
* status is always library-generated and only is concerned with transport-level stream shutdown
* (the call itself may have had a failing status, but if the stream terminated cleanly with the
* status appearing to have been sent, then the passed status here would be {@code OK}). This is
* guaranteed to always be the final call on a listener. No further callbacks will be issued.
*
*
This method should return quickly, as the same thread may be used to process other streams.
*
* @param status details about the remote closure
*/
void closed(Status status);
}