AssociationChangeNotification.java revision 13430:5e8370fb3ed9 
1/*
2 * Copyright (c) 2009, 2013, 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 */
25package com.sun.nio.sctp;
26
27/**
28 * Notification emitted when an association has either opened or closed.
29 *
30 * @since 1.7
31 */
32public abstract class AssociationChangeNotification
33    implements Notification
34{
35    /**
36     * Defines the type of change event that happened to the association.
37     *
38     * @since 1.7
39     */
40    public enum AssocChangeEvent
41    {
42        /**
43         * A new association is now ready and data may be exchanged with this peer.
44         */
45        COMM_UP,
46
47        /**
48         * The association has failed. A series of SCTP send failed notifications
49         * will follow this notification, one for each outstanding message.
50         */
51       COMM_LOST,
52
53        /**
54         * SCTP has detected that the peer has restarted.
55         */
56       RESTART,
57
58        /**
59         * The association has gracefully closed.
60         */
61       SHUTDOWN,
62
63        /**
64         * The association failed to setup. If a message was sent on a {@link
65         * SctpMultiChannel} in non-blocking mode, an
66         * SCTP send failed notification will follow this notification for the
67         * outstanding message.
68         */
69       CANT_START
70    }
71
72    /**
73     * Initializes a new instance of this class.
74     */
75    protected AssociationChangeNotification() {}
76
77    /**
78     * Returns the association that this notification is applicable to.
79     *
80     * @return  The association whose state has changed, or {@code null} if
81     *          there is no association, that is {@linkplain
82     *          AssocChangeEvent#CANT_START CANT_START}
83     */
84    public abstract Association association();
85
86    /**
87     * Returns the type of change event.
88     *
89     * @return  The event
90     */
91    public abstract AssocChangeEvent event();
92}
93