\hypertarget{classProtocolMap}{
\section{ProtocolMap Class Reference}
\label{classProtocolMap}\index{ProtocolMap@{ProtocolMap}}
}


Maps protocols to \hyperlink{protocolthe-p}{the} XORP process name.  




{\ttfamily \#include $<$protocol\_\-map.hh$>$}

Inheritance diagram for ProtocolMap:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classProtocolMap}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const string \& \hyperlink{classProtocolMap_a96d0f238dbdb91cce551561effa8ba47}{xrl\_\-target} (const string \&protocol)
\begin{DoxyCompactList}\small\item\em Determine \hyperlink{protocolthe-p}{the} XRL target for a protocol. \item\end{DoxyCompactList}\item 
void \hyperlink{classProtocolMap_a4eea236eb8c13d25dda09ff70d0afb2d}{set\_\-xrl\_\-target} (const string \&protocol, const string \&target)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} XRL target for a protocol. \item\end{DoxyCompactList}\item 
const string \& \hyperlink{classProtocolMap_a32a3d00c222a1dbcf8c57e161db1c521}{protocol} (const string \&target)
\begin{DoxyCompactList}\small\item\em Return internal protocol name based on XRL target. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Types}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classProtocolMap_ab1cdfbee92bd1fd280d7d53fb9fa57a3}{
typedef map$<$ string, string $>$ {\bfseries Map}}
\label{classProtocolMap_ab1cdfbee92bd1fd280d7d53fb9fa57a3}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classProtocolMap_a7f18410c8d6aaa1dc6ff6971949b9f9d}{
Map {\bfseries \_\-map}}
\label{classProtocolMap_a7f18410c8d6aaa1dc6ff6971949b9f9d}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Maps protocols to \hyperlink{protocolthe-p}{the} XORP process name. By default \hyperlink{protocolthe-p}{the} mapping is \hyperlink{protocolthe-p}{the} protocol name itself unless an entry has been explicitly added. This class is used to map user configuration directives regarding protocols to \hyperlink{protocolthe-p}{the} actual name of \hyperlink{protocolthe-p}{the} XORP process for that protocol. 

\subsection{Member Function Documentation}
\hypertarget{classProtocolMap_a32a3d00c222a1dbcf8c57e161db1c521}{
\index{ProtocolMap@{ProtocolMap}!protocol@{protocol}}
\index{protocol@{protocol}!ProtocolMap@{ProtocolMap}}
\subsubsection[{protocol}]{\setlength{\rightskip}{0pt plus 5cm}const string \& ProtocolMap::protocol (
\begin{DoxyParamCaption}
\item[{const string \&}]{target}
\end{DoxyParamCaption}
)}}
\label{classProtocolMap_a32a3d00c222a1dbcf8c57e161db1c521}


Return internal protocol name based on XRL target. 

\begin{DoxyReturn}{Returns}
protocol name. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em target} & \hyperlink{protocolthe-p}{the} XRL target for \hyperlink{protocolthe-p}{the} protocol. \\
\hline
\end{DoxyParams}
\hypertarget{classProtocolMap_a4eea236eb8c13d25dda09ff70d0afb2d}{
\index{ProtocolMap@{ProtocolMap}!set\_\-xrl\_\-target@{set\_\-xrl\_\-target}}
\index{set\_\-xrl\_\-target@{set\_\-xrl\_\-target}!ProtocolMap@{ProtocolMap}}
\subsubsection[{set\_\-xrl\_\-target}]{\setlength{\rightskip}{0pt plus 5cm}void ProtocolMap::set\_\-xrl\_\-target (
\begin{DoxyParamCaption}
\item[{const string \&}]{protocol, }
\item[{const string \&}]{target}
\end{DoxyParamCaption}
)}}
\label{classProtocolMap_a4eea236eb8c13d25dda09ff70d0afb2d}


Set \hyperlink{protocolthe-p}{the} XRL target for a protocol. 


\begin{DoxyParams}{Parameters}
{\em protocol} & \hyperlink{protocolthe-p}{the} protocol for which \hyperlink{protocolthe-p}{the} XRL target needs to be set. \\
\hline
{\em target} & \hyperlink{protocolthe-p}{the} XRL target for \hyperlink{protocolthe-p}{the} protocol. \\
\hline
\end{DoxyParams}
\hypertarget{classProtocolMap_a96d0f238dbdb91cce551561effa8ba47}{
\index{ProtocolMap@{ProtocolMap}!xrl\_\-target@{xrl\_\-target}}
\index{xrl\_\-target@{xrl\_\-target}!ProtocolMap@{ProtocolMap}}
\subsubsection[{xrl\_\-target}]{\setlength{\rightskip}{0pt plus 5cm}const string \& ProtocolMap::xrl\_\-target (
\begin{DoxyParamCaption}
\item[{const string \&}]{protocol}
\end{DoxyParamCaption}
)}}
\label{classProtocolMap_a96d0f238dbdb91cce551561effa8ba47}


Determine \hyperlink{protocolthe-p}{the} XRL target for a protocol. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} XRL target for \hyperlink{protocolthe-p}{the} protocol. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em protocol} & \hyperlink{protocolthe-p}{the} protocol for which \hyperlink{protocolthe-p}{the} XRL target is wanted. \\
\hline
\end{DoxyParams}


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