opendaylight/hosttracker/api/src/main/java/org/opendaylight/controller/hosttracker/IfNewHostNotify.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 methods for client applications of Host Tracker to
  15  * get notifications when a new host is learned or existing host is removed from
  16  * the network.
  17  *
  18  */
  19 public interface IfNewHostNotify {
  20     /**
  21      * Notifies the HostTracker Clients that a new Host has been learned
  22      *
  23      * @param host
  24      *            Host Info encapsulated in HostNodeConnector class
  25      */
  26     public void notifyHTClient(HostNodeConnector host);
  27
  28     /**
  29      * Notifies the HostTracker Clients that a Host which was learned in the
  30      * past has been removed either due to switch/port down event or due to ARP
  31      * Aging
  32      *
  33      * @param host
  34      *            Host Info encapsulated in HostNodeConnector class
  35      */
  36     public void notifyHTClientHostRemoved(HostNodeConnector host);
  37 }