blob: c27e31108c61adae8b4740043c0b50fb446c14b2 (
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
|
/*
* Copyright 2014 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.net.link;
import java.util.Set;
import org.onosproject.event.ListenerService;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Link;
/**
* Service for interacting with the inventory of infrastructure links.
*/
public interface LinkService
extends ListenerService<LinkEvent, LinkListener> {
/**
* Returns the count of all known infrastructure links.
*
* @return number of infrastructure links
*/
int getLinkCount();
/**
* Returns a collection of all known infrastructure links.
*
* @return all infrastructure links
*/
Iterable<Link> getLinks();
/**
* Returns a collection of all active infrastructure links.
*
* @return all infrastructure links
*/
Iterable<Link> getActiveLinks();
/**
* Returns set of all infrastructure links leading to and from the
* specified device.
*
* @param deviceId device identifier
* @return set of device links
*/
Set<Link> getDeviceLinks(DeviceId deviceId);
/**
* Returns set of all infrastructure links leading from the specified device.
*
* @param deviceId device identifier
* @return set of device egress links
*/
Set<Link> getDeviceEgressLinks(DeviceId deviceId);
/**
* Returns set of all infrastructure links leading to the specified device.
*
* @param deviceId device identifier
* @return set of device ingress links
*/
Set<Link> getDeviceIngressLinks(DeviceId deviceId);
/**
* Returns set of all infrastructure links leading to and from the
* specified connection point.
*
* @param connectPoint connection point
* @return set of links
*/
Set<Link> getLinks(ConnectPoint connectPoint);
/**
* Returns set of all infrastructure links leading from the specified
* connection point.
*
* @param connectPoint connection point
* @return set of device egress links
*/
Set<Link> getEgressLinks(ConnectPoint connectPoint);
/**
* Returns set of all infrastructure links leading to the specified
* connection point.
*
* @param connectPoint connection point
* @return set of device ingress links
*/
Set<Link> getIngressLinks(ConnectPoint connectPoint);
// FIXME: I don't think this makes sense; discuss and remove or adjust return
// to be a Set<Link> or add Link.Type parameter
/**
* Returns the infrastructure links between the specified source
* and destination connection points.
*
* @param src source connection point
* @param dst destination connection point
* @return link from source to destination; null if none found
*/
Link getLink(ConnectPoint src, ConnectPoint dst);
}
|
