Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 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 | */ |
tom | 568581d | 2014-09-08 20:13:36 -0700 | [diff] [blame] | 16 | package org.onlab.onos.net.topology; |
| 17 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 18 | import org.onlab.onos.net.DeviceId; |
| 19 | |
tom | 568581d | 2014-09-08 20:13:36 -0700 | [diff] [blame] | 20 | /** |
| 21 | * Representation of an SCC (strongly-connected component) in a network topology. |
| 22 | */ |
| 23 | public interface TopologyCluster { |
| 24 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 25 | /** |
| 26 | * Returns the cluster id. |
| 27 | * |
| 28 | * @return cluster identifier |
| 29 | */ |
| 30 | ClusterId id(); |
| 31 | |
| 32 | /** |
| 33 | * Returns the number of devices in the cluster. |
| 34 | * |
| 35 | * @return number of cluster devices |
| 36 | */ |
| 37 | int deviceCount(); |
| 38 | |
| 39 | /** |
| 40 | * Returns the number of infrastructure links in the cluster. |
| 41 | * |
| 42 | * @return number of cluster links |
| 43 | */ |
| 44 | int linkCount(); |
| 45 | |
| 46 | /** |
| 47 | * Returns the device identifier of the cluster root device. |
| 48 | * |
| 49 | * @return cluster root device identifier |
| 50 | */ |
| 51 | DeviceId root(); |
tom | 568581d | 2014-09-08 20:13:36 -0700 | [diff] [blame] | 52 | |
| 53 | } |