Showing the changes to java/pkg/com/sun/nio/sctp/NotificationHandler.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,65 @@ | |||
| 1 | /* | ||
| 2 | * Copyright (c) 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 | package com.sun.nio.sctp; | ||
| 26 | |||
| 27 | /** | ||
| 28 | * A handler for consuming notifications from the SCTP stack. | ||
| 29 | * | ||
| 30 | * <P> The SCTP channels defined in this package allow a notification handler to | ||
| 31 | * be specified to consume notifications from the SCTP stack. When a | ||
| 32 | * notification is received the {@linkplain #handleNotification | ||
| 33 | * handleNotification} method of the handler is invoked to handle that | ||
| 34 | * notification. | ||
| 35 | * | ||
| 36 | * <P> Additionally, an attachment object can be attached to the {@code receive} | ||
| 37 | * operation to provide context when consuming the notification. The | ||
| 38 | * attachment is important for cases where a <i>state-less</i> {@code | ||
| 39 | * NotificationHandler} is used to consume the result of many {@code receive} | ||
| 40 | * operations. | ||
| 41 | * | ||
| 42 | * <P> Handler implementations are encouraged to extend the {@link | ||
| 43 | * AbstractNotificationHandler} class which implements this interface and | ||
| 44 | * provide notification specific methods. However, an API should generally use | ||
| 45 | * this handler interface as the type for parameters, return type, etc. rather | ||
| 46 | * than the abstract class. | ||
| 47 | * | ||
| 48 | * @param T The type of the object attached to the receive operation | ||
| 49 | * | ||
| 50 | * @since 1.7 | ||
| 51 | */ | ||
| 52 | public interface NotificationHandler<T> { | ||
| 53 | /** | ||
| 54 | * Invoked when a notification is received from the SCTP stack. | ||
| 55 | * | ||
| 56 | * @param notification | ||
| 57 | * The notification | ||
| 58 | * | ||
| 59 | * @param attachment | ||
| 60 | * The object attached to the receive operation when it was initiated. | ||
| 61 | * | ||
| 62 | * @return The handler result | ||
| 63 | */ | ||
| 64 | HandlerResult handleNotification(Notification notification, T attachment); | ||
| 65 | } | ||