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.Closeable; 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.IOException; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * A channel is a conduit to I/O services covering such items as files, sockets, 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * hardware devices, I/O ports or some software component. 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Channels are open upon creation, and can be closed explicitly. Once a channel 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * is closed it cannot be re-opened, and any attempts to perform I/O operations 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * on the closed channel result in a <code>ClosedChannelException</code>. 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Particular implementations or sub-interfaces of {@code Channel} dictate 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * whether they are thread-safe or not. 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic interface Channel extends Closeable { 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns whether this channel is open or not. 37f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return true if the channel is open, otherwise returns false. 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public boolean isOpen(); 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Closes an open channel. If the channel is already closed then this method 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * has no effect. If there is a problem with closing the channel then the 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * method throws an IOException and the exception contains reasons for the 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * failure. 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If an attempt is made to perform an operation on a closed channel then a 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@link ClosedChannelException} will be thrown on that attempt. 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * <p> 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * If multiple threads attempt to simultaneously close a channel, then only 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * one thread will run the closure code, and others will be blocked until 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the first returns. 54eaa2ff09069424b0f7a95c7cd831cef1b744fe67Jesse Wilson * 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if a problem occurs closing the channel. 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public void close() throws IOException; 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project} 60