blob: 0270996ba1c97a2153746704953d429eb3fb68f8 [file] [log] [blame]
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07001/*
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'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.net.host;
tom0eb04ca2014-08-25 14:34:51 -070017
Brian O'Connorabafb502014-12-02 22:26:20 -080018import org.onosproject.net.Host;
19import org.onosproject.net.provider.Provider;
tom0eb04ca2014-08-25 14:34:51 -070020
21/**
22 * Provider of information about hosts and their location on the network.
23 */
24public interface HostProvider extends Provider {
tome33cc1a2014-08-25 21:59:41 -070025
tome33cc1a2014-08-25 21:59:41 -070026 /**
27 * Triggers an asynchronous probe of the specified host, intended to
28 * determine whether the host is present or not. An indirect result of this
Brian O'Connorabafb502014-12-02 22:26:20 -080029 * should be invocation of {@link org.onosproject.net.host.HostProviderService#hostDetected}
30 * or {@link org.onosproject.net.host.HostProviderService#hostVanished}
tome33cc1a2014-08-25 21:59:41 -070031 * at some later point in time.
32 *
33 * @param host host to probe
34 */
35 void triggerProbe(Host host);
36
tom0eb04ca2014-08-25 14:34:51 -070037}