*: remove the configuration lock from all daemons

[mirror_frr.git] / bgpd / bgp_keepalives.h

diff --git a/bgpd/bgp_keepalives.h b/bgpd/bgp_keepalives.h
index 2bd3964dbe1f01f3ddc6d401dd444373f3d61414..d1cb7d2462ac5c3cea0f6eac52e1ff6aebe882da 100644 (file)
--- a/bgpd/bgp_keepalives.h
+++ b/bgpd/bgp_keepalives.h
@@ -1,39 +1,33 @@
 /* BGP Keepalives.
- *
- * Implemented server-style in a pthread.
- * --------------------------------------
+ * Implements a producer thread to generate BGP keepalives for peers.
  * Copyright (C) 2017 Cumulus Networks, Inc.
+ * Quentin Young
  *
- * This file is part of Free Range Routing.
+ * This file is part of FRRouting.
  *
- * Free Range Routing is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2, or (at your option) any later
+ * FRRouting is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2, or (at your option) any later
  * version.
  *
- * Free Range Routing is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
- * more details.
+ * FRRouting is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
  *
- * You should have received a copy of the GN5U General Public License along
- * with Free Range Routing; see the file COPYING.  If not, write to the Free
- * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
- * 02111-1307, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; see the file COPYING; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
-#ifndef _BGP_KEEPALIVES_H_
-#define _BGP_KEEPALIVES_H_
 
-#include "bgpd.h"
+#ifndef _FRR_BGP_KEEPALIVES_H
+#define _FRR_BGP_KEEPALIVES_H
 
-/* Thread control flag.
- *
- * Setting this flag to 'false' while the thread is running will result in
- * thread termination.
- */
-extern bool bgp_keepalives_thread_run;
+#include "frr_pthread.h"
+#include "bgpd.h"
 
-/* Turns on keepalives for a peer.
+/**
+ * Turns on keepalives for a peer.
  *
  * This function adds the peer to an internal list of peers to generate
  * keepalives for.
@@ -42,49 +36,58 @@ extern bool bgp_keepalives_thread_run;
  * peer->obuf. This operation is thread-safe with respect to peer->obuf.
  *
  * peer->v_keepalive determines the interval. Changing this value before
- * unregistering this peer with peer_keepalives_off() results in undefined
+ * unregistering this peer with bgp_keepalives_off() results in undefined
  * behavior.
  *
  * If the peer is already registered for keepalives via this function, nothing
  * happens.
  */
-extern void peer_keepalives_on(struct peer *);
+extern void bgp_keepalives_on(struct peer *);
 
-/* Turns off keepalives for a peer.
+/**
+ * Turns off keepalives for a peer.
  *
  * Removes the peer from the internal list of peers to generate keepalives for.
  *
  * If the peer is already unregistered for keepalives, nothing happens.
  */
-extern void peer_keepalives_off(struct peer *);
+extern void bgp_keepalives_off(struct peer *);
 
-/* Pre-run initialization function for keepalives pthread.
+/**
+ * Pre-run initialization function for keepalives pthread.
  *
  * Initializes synchronization primitives. This should be called before
  * anything else to avoid race conditions.
  */
-extern void peer_keepalives_init(void);
+extern void bgp_keepalives_init(void);
 
-/* Entry function for keepalives pthread.
+/**
+ * Entry function for keepalives pthread.
  *
  * This function loops over an internal list of peers, generating keepalives at
  * regular intervals as determined by each peer's keepalive timer.
  *
- * See peer_keepalives_on() for additional details.
+ * See bgp_keepalives_on() for additional details.
  *
  * @param arg pthread arg, not used
  */
-extern void *peer_keepalives_start(void *arg);
+extern void *bgp_keepalives_start(void *arg);
 
-/* Poking function for keepalives pthread.
+/**
+ * Poking function for keepalives pthread.
  *
  * Under normal circumstances the pthread will automatically wake itself
  * whenever it is necessary to do work. This function may be used to force the
  * thread to wake up and see if there is any work to do, or if it is time to
  * die.
  *
- * It is not necessary to call this after peer_keepalives_on().
+ * It is not necessary to call this after bgp_keepalives_on().
+ */
+extern void bgp_keepalives_wake(void);
+
+/**
+ * Stops the thread and blocks until it terminates.
  */
-extern void peer_keepalives_wake(void);
+int bgp_keepalives_stop(struct frr_pthread *fpt, void **result);
 
-#endif /* _BGP_KEEPALIVES_H */
+#endif /* _FRR_BGP_KEEPALIVES_H */