tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.device; |
| 2 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 3 | import org.onlab.onos.net.Device; |
| 4 | import org.onlab.onos.net.MastershipRole; |
tom | c1a38d3 | 2014-08-25 23:01:32 -0700 | [diff] [blame] | 5 | import org.onlab.onos.net.provider.Provider; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 6 | |
| 7 | /** |
| 8 | * Abstraction of a device information provider. |
| 9 | */ |
| 10 | public interface DeviceProvider extends Provider { |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 11 | |
| 12 | // TODO: consider how dirty the triggerProbe gets; if it costs too much, let's drop it |
| 13 | |
| 14 | /** |
| 15 | * Triggers an asynchronous probe of the specified device, intended to |
Ayaka Koshibe | e8708e3 | 2014-10-22 13:40:18 -0700 | [diff] [blame] | 16 | * determine whether the device is present or not. An indirect result of this |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 17 | * should be invocation of |
tom | e06f855 | 2014-08-26 16:58:42 -0700 | [diff] [blame] | 18 | * {@link org.onlab.onos.net.device.DeviceProviderService#deviceConnected} )} or |
| 19 | * {@link org.onlab.onos.net.device.DeviceProviderService#deviceDisconnected} |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 20 | * at some later point in time. |
| 21 | * |
| 22 | * @param device device to be probed |
| 23 | */ |
| 24 | void triggerProbe(Device device); |
| 25 | |
| 26 | /** |
| 27 | * Notifies the provider of a mastership role change for the specified |
| 28 | * device as decided by the core. |
| 29 | * |
| 30 | * @param device affected device |
| 31 | * @param newRole newly determined mastership role |
| 32 | */ |
| 33 | void roleChanged(Device device, MastershipRole newRole); |
| 34 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 35 | } |