com.aliyun.openservices.ons.shaded.io.grpc.internal.Deframer Maven / Gradle / Ivy
/*
* Copyright 2017 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 com.aliyun.openservices.ons.shaded.io.grpc.internal;
import com.aliyun.openservices.ons.shaded.io.grpc.Decompressor;
/** Interface for deframing gRPC messages. */
public interface Deframer {
void setMaxInboundMessageSize(int messageSize);
/**
* Sets the decompressor available to use. The message encoding for the stream comes later in
* time, and thus will not be available at the time of construction. This should only be set once,
* since the compression codec cannot change after the headers have been sent.
*
* @param decompressor the decompressing wrapper.
*/
void setDecompressor(Decompressor decompressor);
/**
* Sets the decompressor used for full-stream decompression. Full-stream decompression disables
* any per-message decompressor set by {@link #setDecompressor}.
*
* @param fullStreamDecompressor the decompressing wrapper
*/
void setFullStreamDecompressor(GzipInflatingBuffer fullStreamDecompressor);
/**
* Requests up to the given number of messages from the call. No additional messages will be
* delivered.
*
* If {@link #close()} has been called, this method will have no effect.
*
* @param numMessages the requested number of messages to be delivered to the listener.
*/
void request(int numMessages);
/**
* Adds the given data to this deframer and attempts delivery to the listener.
*
* @param data the raw data read from the remote endpoint. Must be non-null.
*/
void deframe(ReadableBuffer data);
/** Close when any messages currently queued have been requested and delivered. */
void closeWhenComplete();
/**
* Closes this deframer and frees any resources. After this method is called, additional calls
* will have no effect.
*/
void close();
}