/*

 * Copyright 2009 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package com.sun.nio.sctp;

/**

 * A skeletal handler that consumes notifications and continues.

 *

 * <P> This class trivially implements the {@code handleNotification} methods to

 * return {@link HandlerResult#CONTINUE CONTINUE} so that all notifications are

 * consumed and the channel continues to try and receive a message.

 *

 * <P> It also provides overloaded versions of the {@code handleNotification}

 * methods, one for each of the required supported notification types, {@link

 * AssociationChangeNotification}, {@link PeerAddressChangeNotification},

 * {@link SendFailedNotification}, and {@link ShutdownNotification}. The

 * appropriate method will be invoked when the notification is received.

 *

 * @since 1.7

 */

public class AbstractNotificationHandler<T>

    implements NotificationHandler<T>

{

    /**

     * Initializes a new instance of this class.

     */

    protected AbstractNotificationHandler() {}

    /**

     * Invoked when an implementation specific notification is received from the

     * SCTP stack.

     *

     * @param  notification

     *         The notification

     *

     * @param  attachment

     *         The object attached to the {@code receive} operation when it was

     *         initiated.

     *

     * @return  The handler result

     */

    @Override

    public HandlerResult handleNotification(Notification notification,

                                            T attachment) {

        return HandlerResult.CONTINUE;

    }

    /**

     * Invoked when an {@link AssociationChangeNotification} is received from

     * the SCTP stack.

     *

     * @param  notification

     *         The notification

     *

     * @param  attachment

     *         The object attached to the {@code receive} operation when it was

     *         initiated.

     *

     * @return  The handler result

     */

    public HandlerResult handleNotification(AssociationChangeNotification notification,

                                            T attachment) {

        return HandlerResult.CONTINUE;

    }

    /**

     * Invoked when an {@link PeerAddressChangeNotification} is received from

     * the SCTP stack.

     *

     * @param  notification

     *         The notification

     *

     * @param  attachment

     *         The object attached to the {@code receive} operation when it was

     *         initiated.

     *

     * @return  The handler result

     */

    public HandlerResult handleNotification(PeerAddressChangeNotification notification,

                                            T attachment) {

        return HandlerResult.CONTINUE;

    }

    /**

     * Invoked when an {@link SendFailedNotification} is received from

     * the SCTP stack.

     *

     * @param  notification

     *         The notification

     *

     * @param  attachment

     *         The object attached to the {@code receive} operation when it was

     *         initiated.

     *

     * @return  The handler result

     */

    public HandlerResult handleNotification(SendFailedNotification notification,

                                            T attachment) {

        return HandlerResult.CONTINUE;

    }

    /**

     * Invoked when an {@link ShutdownNotification} is received from

     * the SCTP stack.

     *

     * @param  notification

     *         The notification

     *

     * @param  attachment

     *         The object attached to the {@code receive} operation when it was

     *         initiated.

     *

     * @return  The handler result

     */

    public HandlerResult handleNotification(ShutdownNotification notification,

                                            T attachment) {

        return HandlerResult.CONTINUE;

    }

}