\hypertarget{classBGPPeerList}{
\section{BGPPeerList Class Reference}
\label{classBGPPeerList}\index{BGPPeerList@{BGPPeerList}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{classBGPPeerList_acab47ad77398f5b4d0c6b82eb5e14162}{all\_\-stop} (bool restart=false)
\begin{DoxyCompactList}\small\item\em Stop all \hyperlink{protocolthe-p}{the} peerings. \item\end{DoxyCompactList}\item 
bool \hyperlink{classBGPPeerList_a138f67d0f32f38707dc100d2893d8868}{not\_\-all\_\-idle} ()
\begin{DoxyCompactList}\small\item\em Are \hyperlink{protocolthe-p}{the} peers idle? Used to poll \hyperlink{protocolthe-p}{the} peers when BGP is being gracefully taken down. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_a65a2d2ab3a234f666298ec88f68c1645}{
void \hyperlink{classBGPPeerList_a65a2d2ab3a234f666298ec88f68c1645}{add\_\-peer} (\hyperlink{classBGPPeer}{BGPPeer} $\ast$p)}
\label{classBGPPeerList_a65a2d2ab3a234f666298ec88f68c1645}

\begin{DoxyCompactList}\small\item\em Add this peer to \hyperlink{protocolthe-p}{the} peer list. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_a70543c18d439f7eee06936f558ef2240}{
void \hyperlink{classBGPPeerList_a70543c18d439f7eee06936f558ef2240}{remove\_\-peer} (\hyperlink{classBGPPeer}{BGPPeer} $\ast$p)}
\label{classBGPPeerList_a70543c18d439f7eee06936f558ef2240}

\begin{DoxyCompactList}\small\item\em Remove \hyperlink{protocolthe-p}{the} peer from \hyperlink{protocolthe-p}{the} peer list and delete it. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_aed41670c9ad524418cba4c4f303328e8}{
void \hyperlink{classBGPPeerList_aed41670c9ad524418cba4c4f303328e8}{detach\_\-peer} (\hyperlink{classBGPPeer}{BGPPeer} $\ast$p)}
\label{classBGPPeerList_aed41670c9ad524418cba4c4f303328e8}

\begin{DoxyCompactList}\small\item\em Detach this peer from \hyperlink{protocolthe-p}{the} peer list (DO NOT DELETE IT). \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_acf76c8588f08790f4f09208c61427b33}{
list$<$ \hyperlink{classBGPPeer}{BGPPeer} $\ast$ $>$ \& \hyperlink{classBGPPeerList_acf76c8588f08790f4f09208c61427b33}{get\_\-list} ()}
\label{classBGPPeerList_acf76c8588f08790f4f09208c61427b33}

\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} list of attached peers. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_ae3646bb8f8817aa013d78d4473cd872d}{
void \hyperlink{classBGPPeerList_ae3646bb8f8817aa013d78d4473cd872d}{dump\_\-list} ()}
\label{classBGPPeerList_ae3646bb8f8817aa013d78d4473cd872d}

\begin{DoxyCompactList}\small\item\em Debugging entry point that prints all \hyperlink{protocolthe-p}{the} peers. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_a1e2bac0fe55f944c5a0178adb49654bb}{
bool \hyperlink{classBGPPeerList_a1e2bac0fe55f944c5a0178adb49654bb}{get\_\-peer\_\-list\_\-start} (uint32\_\-t \&token)}
\label{classBGPPeerList_a1e2bac0fe55f944c5a0178adb49654bb}

\begin{DoxyCompactList}\small\item\em Aquire a token that can be used to scan through \hyperlink{protocolthe-p}{the} peers. \item\end{DoxyCompactList}\item 
\hypertarget{classBGPPeerList_ad666fcf2ac5ae5623b9b8bcaccf01b95}{
bool \hyperlink{classBGPPeerList_ad666fcf2ac5ae5623b9b8bcaccf01b95}{get\_\-peer\_\-list\_\-next} (const uint32\_\-t \&token, string \&local\_\-ip, uint32\_\-t \&local\_\-port, string \&peer\_\-ip, uint32\_\-t \&peer\_\-port)}
\label{classBGPPeerList_ad666fcf2ac5ae5623b9b8bcaccf01b95}

\begin{DoxyCompactList}\small\item\em Using \hyperlink{protocolthe-p}{the} token get information about \hyperlink{protocolthe-p}{the} peers. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classBGPPeerList_aab7026b63205a0501d89b346f9c0db93}{
list$<$ \hyperlink{classBGPPeer}{BGPPeer} $\ast$ $>$ {\bfseries \_\-peers}}
\label{classBGPPeerList_aab7026b63205a0501d89b346f9c0db93}

\item 
\hypertarget{classBGPPeerList_a54fb95676098c19e692f642081f3ba00}{
map$<$ uint32\_\-t, list$<$ \hyperlink{classBGPPeer}{BGPPeer} $\ast$ $>$::iterator $>$ {\bfseries \_\-readers}}
\label{classBGPPeerList_a54fb95676098c19e692f642081f3ba00}

\item 
\hypertarget{classBGPPeerList_ab72253d256ee3a7834eada142010131a}{
uint32\_\-t {\bfseries \_\-next\_\-token}}
\label{classBGPPeerList_ab72253d256ee3a7834eada142010131a}

\end{DoxyCompactItemize}


\subsection{Member Function Documentation}
\hypertarget{classBGPPeerList_acab47ad77398f5b4d0c6b82eb5e14162}{
\index{BGPPeerList@{BGPPeerList}!all\_\-stop@{all\_\-stop}}
\index{all\_\-stop@{all\_\-stop}!BGPPeerList@{BGPPeerList}}
\subsubsection[{all\_\-stop}]{\setlength{\rightskip}{0pt plus 5cm}void BGPPeerList::all\_\-stop (
\begin{DoxyParamCaption}
\item[{bool}]{restart = {\ttfamily false}}
\end{DoxyParamCaption}
)}}
\label{classBGPPeerList_acab47ad77398f5b4d0c6b82eb5e14162}


Stop all \hyperlink{protocolthe-p}{the} peerings. 


\begin{DoxyParams}{Parameters}
{\em restart} & if true will bounce \hyperlink{protocolthe-p}{the} peerings, if false \hyperlink{protocolthe-p}{the} peerings will be taken down and kept down. \\
\hline
\end{DoxyParams}
\hypertarget{classBGPPeerList_a138f67d0f32f38707dc100d2893d8868}{
\index{BGPPeerList@{BGPPeerList}!not\_\-all\_\-idle@{not\_\-all\_\-idle}}
\index{not\_\-all\_\-idle@{not\_\-all\_\-idle}!BGPPeerList@{BGPPeerList}}
\subsubsection[{not\_\-all\_\-idle}]{\setlength{\rightskip}{0pt plus 5cm}bool BGPPeerList::not\_\-all\_\-idle (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classBGPPeerList_a138f67d0f32f38707dc100d2893d8868}


Are \hyperlink{protocolthe-p}{the} peers idle? Used to poll \hyperlink{protocolthe-p}{the} peers when BGP is being gracefully taken down. 

\begin{DoxyReturn}{Returns}
true while peers are still active. 
\end{DoxyReturn}


The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/bgp/peer\_\-list.hh\item 
/home/greearb/git/xorp.ct.github/xorp/bgp/peer\_\-list.cc\end{DoxyCompactItemize}
