pimd/pim_bfd.h

   1 /*
   2  * pim_bfd.h: PIM BFD definitions and structures
   3  *
   4  * Copyright (C) 2017 Cumulus Networks, Inc.
   5  * Chirag Shah
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; see the file COPYING; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  20  * MA 02110-1301 USA
  21  */
  22
  23 #ifndef PIM_BFD_H
  24 #define PIM_BFD_H
  25
  26 #include "if.h"
  27
  28 /**
  29  * Initializes PIM BFD integration code.
  30  */
  31 void pim_bfd_init(void);
  32
  33 /**
  34  * Write configuration to `show running-config`.
  35  *
  36  * \param vty the vty output pointer.
  37  * \param ifp the interface pointer that has the configuration.
  38  */
  39 void pim_bfd_write_config(struct vty *vty, struct interface *ifp);
  40
  41 /**
  42  * Enables or disables all peers BFD sessions.
  43  *
  44  * \param ifp interface pointer.
  45  * \param enable session state to set.
  46  */
  47 void pim_bfd_reg_dereg_all_nbr(struct interface *ifp);
  48
  49 /**
  50  * Create and configure peer BFD session if it does not exist. It will use
  51  * the interface configured parameters as the peer configuration.
  52  *
  53  * \param pim_ifp the interface configuration pointer.
  54  * \param neigh the neighbor configuration pointer.
  55  */
  56 void pim_bfd_info_nbr_create(struct pim_interface *pim_ifp,
  57                              struct pim_neighbor *neigh);
  58
  59 #endif /* _PIM_BFD_H */