opendaylight/hosttracker/api/src/main/java/org/opendaylight/controller/hosttracker/hostAware/IHostFinder.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.hostAware;
  10
  11 import java.net.InetAddress;
  12
  13 /**
  14  * This Interface defines the methods to trigger the discovery of a Host and to
  15  * probe if a learned Host is still in the network.
  16  *
  17  *
  18  *
  19  */
  20 public interface IHostFinder {
  21     /**
  22      * This method initiates the discovery of a host based on its IP address.
  23      * This is triggered by query of an application to the HostTracker. The
  24      * requested IP address doesn't exist in the local database at this point.
  25      *
  26      * @param networkAddress
  27      *            IP Address encapsulated in InetAddress class
  28      *
  29      */
  30     public void find(InetAddress networkAddress);
  31
  32     /**
  33      * This method is called by HostTracker to see if a learned Host is still in
  34      * the network. Used mostly for ARP Aging.
  35      *
  36      * @param host
  37      *            The Host that needs to be probed
  38      */
  39     public void probe(HostNodeConnector host);
  40 }