opendaylight/hosttracker/api/src/main/java/org/opendaylight/controller/hosttracker/IfNewHostNotify.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.hosttracker;
  11
  12 import org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector;
  13
  14 /**
  15  * This Interface defines the methods for client applications of
  16  * Host Tracker to get notifications when a new host is learned or
  17  * existing host is removed from the network.
  18  *
  19  */
  20 public interface IfNewHostNotify {
  21     /**
  22      * Notifies the HostTracker Clients that a new Host has been learned
  23      *
  24      * @param host              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
  30      * the past has been removed either due to switch/port down event or
  31      * due to ARP Aging
  32      *
  33      * @param host              Host Info encapsulated in HostNodeConnector class
  34      */
  35     public void notifyHTClientHostRemoved(HostNodeConnector host);
  36 }