blob: 9d44041e483f15cb6205d034c4700c45299042b1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.bgp.controller;
import java.util.Map;
import java.util.Set;
import org.onosproject.bgpio.exceptions.BGPParseException;
import org.onosproject.bgpio.protocol.BGPMessage;
/**
* Abstraction of an BGP controller. Serves as a one stop shop for obtaining BGP devices and (un)register listeners on
* bgp events
*/
public interface BGPController {
/**
* Returns list of bgp peers connected to this BGP controller.
*
* @return Iterable of BGPPeer elements
*/
Iterable<BGPPeer> getPeers();
/**
* Returns the actual bgp peer for the given ip address.
*
* @param bgpId the id of the bgp peer to fetch
* @return the interface to this bgp peer
*/
BGPPeer getPeer(BGPId bgpId);
/**
* Register a listener for BGP message events.
*
* @param listener the listener to notify
*/
void addListener(BgpNodeListener listener);
/**
* Unregister a listener.
*
* @param listener the listener to unregister
*/
void removeListener(BgpNodeListener listener);
/**
* Register a listener for BGP message events.
*
* @param listener the listener to notify
*/
void addLinkListener(BgpLinkListener listener);
/**
* Unregister a listener.
*
* @param listener the listener to unregister
*/
void removeLinkListener(BgpLinkListener listener);
/**
* Send a message to a particular bgp peer.
*
* @param bgpId the id of the peer to send message.
* @param msg the message to send
*/
void writeMsg(BGPId bgpId, BGPMessage msg);
/**
* Process a message and notify the appropriate listeners.
*
* @param bgpId id of the peer the message arrived on
* @param msg the message to process.
* @throws BGPParseException on data processing error
*/
void processBGPPacket(BGPId bgpId, BGPMessage msg) throws BGPParseException;
/**
* Close all connected BGP peers.
*
*/
void closeConnectedPeers();
/**
* Get the BGPConfig class to the caller.
*
* @return configuration object
*/
BGPCfg getConfig();
/**
* Get the BGP connected peers to this controller.
*
* @return the integer number
*/
int connectedPeerCount();
/**
* Return BGP peer manager.
*
* @return BGPPeerManager peer manager instance
*/
BgpPeerManager peerManager();
/**
* Return BGP connected peers.
*
* @return connectedPeers connected peers
*/
Map<BGPId, BGPPeer> connectedPeers();
/**
* Return BGP node listener.
*
* @return node listener
*/
Set<BgpNodeListener> listener();
/**
* Return BGP link listener.
*
* @return link listener
*/
Set<BgpLinkListener> linkListener();
}
|
