1 /* 2 * Copyright 2014 The gRPC Authors 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package io.grpc; 18 19 import java.io.IOException; 20 21 /** 22 * An {@link java.io.InputStream} or alike whose total number of bytes that can be read is known 23 * upfront. 24 * 25 * <p>Usually it's a {@link java.io.InputStream} that also implements this interface, in which case 26 * {@link java.io.InputStream#available()} has a stronger semantic by returning an accurate number 27 * instead of an estimation. 28 */ 29 public interface KnownLength { 30 /** 31 * Returns the total number of bytes that can be read (or skipped over) from this object until all 32 * bytes have been read out. 33 */ available()34 int available() throws IOException; 35 } 36