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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.device; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
| 19 | import org.onosproject.net.MastershipRole; |
| 20 | import org.onosproject.net.provider.Provider; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Abstraction of a device information provider. |
| 24 | */ |
| 25 | public interface DeviceProvider extends Provider { |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 26 | |
| 27 | // TODO: consider how dirty the triggerProbe gets; if it costs too much, let's drop it |
| 28 | |
| 29 | /** |
| 30 | * Triggers an asynchronous probe of the specified device, intended to |
Ayaka Koshibe | e8708e3 | 2014-10-22 13:40:18 -0700 | [diff] [blame] | 31 | * determine whether the device is present or not. An indirect result of this |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 32 | * should be invocation of |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 33 | * {@link org.onosproject.net.device.DeviceProviderService#deviceConnected} )} or |
| 34 | * {@link org.onosproject.net.device.DeviceProviderService#deviceDisconnected} |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 35 | * at some later point in time. |
| 36 | * |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 37 | * @param deviceId ID of device to be probed |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 38 | */ |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 39 | void triggerProbe(DeviceId deviceId); |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
| 42 | * Notifies the provider of a mastership role change for the specified |
| 43 | * device as decided by the core. |
| 44 | * |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 45 | * @param deviceId device identifier |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 46 | * @param newRole newly determined mastership role |
| 47 | */ |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 48 | void roleChanged(DeviceId deviceId, MastershipRole newRole); |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 49 | |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 50 | /** |
| 51 | * Checks the reachability (connectivity) of a device from this provider. |
| 52 | * |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 53 | * @param deviceId device identifier |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 54 | * @return true if reachable, false otherwise |
| 55 | */ |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 56 | boolean isReachable(DeviceId deviceId); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 57 | } |