|
1 /* |
|
2 * Copyright 2009 Sun Microsystems, Inc. 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. Sun designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
|
22 * CA 95054 USA or visit www.sun.com if you need additional information or |
|
23 * have any questions. |
|
24 */ |
|
25 package com.sun.nio.sctp; |
|
26 |
|
27 import java.net.SocketAddress; |
|
28 |
|
29 /** |
|
30 * Notification emitted when a destination address on a multi-homed peer |
|
31 * encounters a change. |
|
32 * |
|
33 * @since 1.7 |
|
34 */ |
|
35 public abstract class PeerAddressChangeNotification |
|
36 implements Notification |
|
37 { |
|
38 /** |
|
39 * Defines the type of address change event that occurred to the destination |
|
40 * address on a multi-homed peer when it encounters a change of interface |
|
41 * details. |
|
42 * |
|
43 * <P> Some of these events types are only generated when the association |
|
44 * supports dynamic address reconfiguration, e.g. {@code SCTP_ADDR_ADDED}, |
|
45 * {@code SCTP_ADDR_REMOVED}, etc. |
|
46 * |
|
47 * @since 1.7 |
|
48 */ |
|
49 public enum AddressChangeEvent { |
|
50 /** |
|
51 * This address is now reachable. |
|
52 */ |
|
53 ADDR_AVAILABLE, |
|
54 |
|
55 /** |
|
56 * The address specified can no longer be reached. Any data sent to this |
|
57 * address is rerouted to an alternate until this address becomes reachable. |
|
58 */ |
|
59 ADDR_UNREACHABLE, |
|
60 |
|
61 /** |
|
62 * The address is no longer part of the association. |
|
63 */ |
|
64 ADDR_REMOVED, |
|
65 |
|
66 /** |
|
67 * The address is now part of the association. |
|
68 */ |
|
69 ADDR_ADDED, |
|
70 |
|
71 /** |
|
72 * This address has now been made to be the primary destination address. |
|
73 */ |
|
74 ADDR_MADE_PRIMARY, |
|
75 |
|
76 /** |
|
77 * This address has now been confirmed as a valid address. |
|
78 */ |
|
79 ADDR_CONFIRMED; |
|
80 } |
|
81 |
|
82 /** |
|
83 * Initializes a new instance of this class. |
|
84 */ |
|
85 protected PeerAddressChangeNotification() {} |
|
86 |
|
87 /** |
|
88 * Returns the peer address. |
|
89 * |
|
90 * @return The peer address |
|
91 */ |
|
92 public abstract SocketAddress address(); |
|
93 |
|
94 /** |
|
95 * Returns the association that this notification is applicable to. |
|
96 * |
|
97 * @return The association whose peer address changed |
|
98 */ |
|
99 public abstract Association association(); |
|
100 |
|
101 /** |
|
102 * Returns the type of change event. |
|
103 * |
|
104 * @return The event |
|
105 */ |
|
106 public abstract AddressChangeEvent event(); |
|
107 } |