1 /* 2 * Copyright (c) 2007, 2009, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.nio.channels; 27 28 /** 29 * A handler for consuming the result of an asynchronous I/O operation. 30 * 31 * <p> The asynchronous channels defined in this package allow a completion 32 * handler to be specified to consume the result of an asynchronous operation. 33 * The {@link #completed completed} method is invoked when the I/O operation 34 * completes successfully. The {@link #failed failed} method is invoked if the 35 * I/O operations fails. The implementations of these methods should complete 36 * in a timely manner so as to avoid keeping the invoking thread from dispatching 37 * to other completion handlers. 38 * 39 * @param <V> The result type of the I/O operation 40 * @param <A> The type of the object attached to the I/O operation 41 * 42 * @since 1.7 43 */ 44 45 public interface CompletionHandler<V,A> { 46 47 /** 48 * Invoked when an operation has completed. 49 * 50 * @param result 51 * The result of the I/O operation. 52 * @param attachment 53 * The object attached to the I/O operation when it was initiated. 54 */ completed(V result, A attachment)55 void completed(V result, A attachment); 56 57 /** 58 * Invoked when an operation fails. 59 * 60 * @param exc 61 * The exception to indicate why the I/O operation failed 62 * @param attachment 63 * The object attached to the I/O operation when it was initiated. 64 */ failed(Throwable exc, A attachment)65 void failed(Throwable exc, A attachment); 66 } 67