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