1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* Licensed to the Apache Software Foundation (ASF) under one or more 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 7f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.nio.channels; 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.IOException; 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.nio.ByteBuffer; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * A {@code ReadableByteChannel} is a type of {@link Channel} that can read 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * bytes. 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Read operations are synchronous on a {@code ReadableByteChannel}, that is, 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a read is already in progress on the channel then subsequent reads will 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * block until the first read completes. It is undefined whether non-read 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * operations will block. 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic interface ReadableByteChannel extends Channel { 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Reads bytes from the channel into the given buffer. 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The maximum number of bytes that will be read is the 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link java.nio.Buffer#remaining() remaining} number of bytes in the 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * buffer when the method is invoked. The bytes will be read into the buffer 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * starting at the buffer's current 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link java.nio.Buffer#position() position}. 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The call may block if other threads are also attempting to read from the 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * same channel. 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Upon completion, the buffer's {@code position} is updated to the end of 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the bytes that were read. The buffer's 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link java.nio.Buffer#limit() limit} is not changed. 48eaa2ff09069424b0f7a95c7cd831cef1b744fe67Jesse Wilson * 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param buffer 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the byte buffer to receive the bytes. 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the number of bytes actually read. 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws AsynchronousCloseException 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if another thread closes the channel during the read. 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws ClosedByInterruptException 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if another thread interrupts the calling thread while the 56eaa2ff09069424b0f7a95c7cd831cef1b744fe67Jesse Wilson * operation is in progress. The interrupt state of the calling 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * thread is set and the channel is closed. 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws ClosedChannelException 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the channel is closed. 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * another I/O error occurs, details are in the message. 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws NonReadableChannelException 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if the channel was not opened for reading. 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public int read(ByteBuffer buffer) throws IOException; 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 67