sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.ospf.controller; |
| 17 | |
| 18 | /** |
| 19 | * Representation of an OSPF agent. |
| 20 | * It is responsible for keeping track of the current set of routers |
| 21 | * connected to the system. |
| 22 | */ |
| 23 | public interface OspfAgent { |
| 24 | |
| 25 | /** |
| 26 | * Adds a router that has just connected to the system. |
| 27 | * |
| 28 | * @param ospfRouter the router id to add |
| 29 | * @return true if added, false otherwise |
| 30 | */ |
| 31 | boolean addConnectedRouter(OspfRouter ospfRouter); |
| 32 | |
| 33 | /** |
| 34 | * Removes the router which got disconnected from the system. |
| 35 | * |
| 36 | * @param ospfRouter the router id to remove |
| 37 | */ |
| 38 | void removeConnectedRouter(OspfRouter ospfRouter); |
| 39 | |
| 40 | /** |
sunishvk | f7c5655 | 2016-07-18 16:02:39 +0530 | [diff] [blame] | 41 | * Notifies that got a packet of link from network and need to add the link. |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 42 | * |
sunishvk | f7c5655 | 2016-07-18 16:02:39 +0530 | [diff] [blame] | 43 | * @param ospfRouter router instance |
| 44 | * @param ospfLinkTed link TED instance |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 45 | */ |
| 46 | void addLink(OspfRouter ospfRouter, OspfLinkTed ospfLinkTed); |
| 47 | |
| 48 | /** |
sunishvk | f7c5655 | 2016-07-18 16:02:39 +0530 | [diff] [blame] | 49 | * Notifies that got a packet of link from network and need do delete the link. |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 50 | * |
| 51 | * @param ospfRouter router instance |
sunishvk | f7c5655 | 2016-07-18 16:02:39 +0530 | [diff] [blame] | 52 | * @param ospfLinkTed link TED instance |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 53 | */ |
sunishvk | f7c5655 | 2016-07-18 16:02:39 +0530 | [diff] [blame] | 54 | void deleteLink(OspfRouter ospfRouter, OspfLinkTed ospfLinkTed); |
sunish vk | 30637eb | 2016-02-16 15:19:32 +0530 | [diff] [blame] | 55 | } |