diff options
Diffstat (limited to 'framework/src/onos/bgp/api/src/main/java/org')
2 files changed, 189 insertions, 0 deletions
diff --git a/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPController.java b/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPController.java index 6d758122..49432aab 100755 --- a/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPController.java +++ b/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPController.java @@ -25,6 +25,21 @@ import org.onosproject.bgpio.protocol.BGPMessage; 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); + + /** * Send a message to a particular bgp peer. * * @param bgpId the id of the peer to send message. @@ -41,9 +56,22 @@ public interface BGPController { void processBGPPacket(BGPId bgpId, BGPMessage msg); /** + * 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 getBGPConnNumber(); }
\ No newline at end of file diff --git a/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPPeer.java b/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPPeer.java new file mode 100755 index 00000000..1b022c76 --- /dev/null +++ b/framework/src/onos/bgp/api/src/main/java/org/onosproject/bgp/controller/BGPPeer.java @@ -0,0 +1,161 @@ +/* + * 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.List; +import org.jboss.netty.channel.Channel; +import org.onosproject.bgpio.protocol.BGPMessage; +import org.onosproject.bgpio.protocol.BGPVersion; + +/** + * Represents the peer side of an bgp peer. + * + */ +public interface BGPPeer { + + /** + * Sets the BGP version for this bgp peer. + * + * @param bgpVersion the version to set. + */ + void setBgpPeerVersion(BGPVersion bgpVersion); + + /** + * Gets the BGP version for this bgp peer. + * + * @return bgp identifier. + */ + int getBgpPeerIdentifier(); + + /** + * Sets the associated Netty channel for this bgp peer. + * + * @param channel the Netty channel + */ + void setChannel(Channel channel); + + /** + * Gets the associated Netty channel handler for this bgp peer. + * + * @return Channel channel connected. + */ + Channel getChannel(); + + /** + * Sets the AS Number for this bgp peer. + * + * @param peerASNum the autonomous system number value to set. + */ + void setBgpPeerASNum(short peerASNum); + + /** + * Sets the hold time for this bgp peer. + * + * @param peerHoldTime the hold timer value to set. + */ + void setBgpPeerHoldTime(short peerHoldTime); + + /** + * Sets the peer identifier value. + * + * @param peerIdentifier the bgp peer identifier value. + */ + void setBgpPeerIdentifier(int peerIdentifier); + + /** + * Sets whether the bgp peer is connected. + * + * @param connected whether the bgp peer is connected + */ + void setConnected(boolean connected); + + /** + * Initialises the behaviour. + * + * @param bgpId id of bgp peer + * @param bgpVersion BGP version + * @param pktStats packet statistics + */ + void init(BGPId bgpId, BGPVersion bgpVersion, BGPPacketStats pktStats); + + /** + * Checks whether the handshake is complete. + * + * @return true is finished, false if not. + */ + boolean isHandshakeComplete(); + + /** + * Writes the message to the peer. + * + * @param msg the message to write + */ + void sendMessage(BGPMessage msg); + + /** + * Writes the BGPMessage list to the peer. + * + * @param msgs the messages to be written + */ + void sendMessage(List<BGPMessage> msgs); + + /** + * Gets a string version of the ID for this bgp peer. + * + * @return string version of the ID + */ + String getStringId(); + + /** + * Gets the ipAddress of the peer. + * + * @return the peer bgpId in IPAddress format + */ + BGPId getBGPId(); + + /** + * Checks if the bgp peer is still connected. + * + * @return whether the bgp peer is still connected + */ + boolean isConnected(); + + /** + * Disconnects the bgp peer by closing the TCP connection. Results in a call to the channel handler's + * channelDisconnected method for cleanup + */ + void disconnectPeer(); + + /** + * Identifies the channel used to communicate with the bgp peer. + * + * @return string representation of the connection to the peer + */ + String channelId(); + + /** + * Gets the negotiated hold time. + * + * @return the negotiated hold time + */ + int getNegotiatedHoldTime(); + + /** + * Sets negotiated hold time for the peer. + * + * @param negotiatedHoldTime negotiated hold time + */ + void setNegotiatedHoldTime(short negotiatedHoldTime); +} |