blob: 59ddcc23e293c2c7e25220127030803815b2eaf5 [file] [log] [blame]
tom0eb04ca2014-08-25 14:34:51 -07001package org.onlab.onos.net.host;
2
tome33cc1a2014-08-25 21:59:41 -07003import org.onlab.onos.net.Host;
4import org.onlab.onos.provider.Provider;
tom0eb04ca2014-08-25 14:34:51 -07005
6/**
7 * Provider of information about hosts and their location on the network.
8 */
9public interface HostProvider extends Provider {
tome33cc1a2014-08-25 21:59:41 -070010
11 // TODO: consider how dirty the triggerProbe gets; if it costs too much, let's drop it
12
13 /**
14 * Triggers an asynchronous probe of the specified host, intended to
15 * determine whether the host is present or not. An indirect result of this
16 * should be invocation of {@link org.onlab.onos.net.host.HostProviderService#hostDetected(HostDescription)} or
17 * {@link org.onlab.onos.net.host.HostProviderService#hostNotDetected(HostDescription)}
18 * at some later point in time.
19 *
20 * @param host host to probe
21 */
22 void triggerProbe(Host host);
23
tom0eb04ca2014-08-25 14:34:51 -070024}