diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java new file mode 100644 index 00000000..d8adbb0e --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/DeviceProvider.java @@ -0,0 +1,57 @@ +/* + * 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.device; + +import org.onosproject.net.DeviceId; +import org.onosproject.net.MastershipRole; +import org.onosproject.net.provider.Provider; + +/** + * Abstraction of a device information provider. + */ +public interface DeviceProvider extends Provider { + + // TODO: consider how dirty the triggerProbe gets; if it costs too much, let's drop it + + /** + * Triggers an asynchronous probe of the specified device, intended to + * determine whether the device is present or not. An indirect result of this + * should be invocation of + * {@link org.onosproject.net.device.DeviceProviderService#deviceConnected} )} or + * {@link org.onosproject.net.device.DeviceProviderService#deviceDisconnected} + * at some later point in time. + * + * @param deviceId ID of device to be probed + */ + void triggerProbe(DeviceId deviceId); + + /** + * Notifies the provider of a mastership role change for the specified + * device as decided by the core. + * + * @param deviceId device identifier + * @param newRole newly determined mastership role + */ + void roleChanged(DeviceId deviceId, MastershipRole newRole); + + /** + * Checks the reachability (connectivity) of a device from this provider. + * + * @param deviceId device identifier + * @return true if reachable, false otherwise + */ + boolean isReachable(DeviceId deviceId); +} |