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