Merge "Bug 1029: Remove dead code: samples/clustersession"
[controller.git] / opendaylight / adsal / hosttracker / api / src / main / java / org / opendaylight / controller / hosttracker / IfHostListener.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.controller.hosttracker;
10
11 import org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector;
12
13 /**
14  * This interface defines the method to notify detected Host on the network. The
15  * information includes Host's IP address, MAC address, switch ID, port, and
16  * VLAN.
17  *
18  */
19
20 public interface IfHostListener {
21     /**
22      * Learns new Hosts. Called by ArpHandler and implemented in
23      * HostTracker.java. If a Host is learned for the first time then adds it to
24      * the local database and informs other applications of coming up a new
25      * Host. For the hosts which it has already learned, it refreshes them.
26      *
27      * @param host
28      *            Host info encapsulated in HostNodeConnector class
29      */
30     public void hostListener(HostNodeConnector host);
31 }