\hypertarget{classSummaryNetworkLsa}{
\section{SummaryNetworkLsa Class Reference}
\label{classSummaryNetworkLsa}\index{SummaryNetworkLsa@{SummaryNetworkLsa}}
}


OSPFv2: Summary-\/LSA Type 3 OSPFv3: Inter-\/Area-\/Prefix-\/LSA.  




{\ttfamily \#include $<$lsa.hh$>$}

Inheritance diagram for SummaryNetworkLsa:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classSummaryNetworkLsa}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classSummaryNetworkLsa_ab914fbf2542a35a22d4a07700fd42d7e}{
{\bfseries SummaryNetworkLsa} (\hyperlink{structOspfTypes_a60eb031df0c10af753789ae76b185ec2}{OspfTypes::Version} version)}
\label{classSummaryNetworkLsa_ab914fbf2542a35a22d4a07700fd42d7e}

\item 
\hypertarget{classSummaryNetworkLsa_adecb28882827a5d155f2db35176bff3e}{
{\bfseries SummaryNetworkLsa} (\hyperlink{structOspfTypes_a60eb031df0c10af753789ae76b185ec2}{OspfTypes::Version} version, uint8\_\-t $\ast$buf, size\_\-t len)}
\label{classSummaryNetworkLsa_adecb28882827a5d155f2db35176bff3e}

\item 
size\_\-t \hyperlink{classSummaryNetworkLsa_af684818f7a4f7ea3bd535e7c677f2047}{min\_\-length} () const 
\item 
uint16\_\-t \hyperlink{classSummaryNetworkLsa_ad7f0194514396d9bb7abf9b0cfef10bf}{get\_\-ls\_\-type} () const 
\begin{DoxyCompactList}\small\item\em It is \hyperlink{protocolthe-p}{the} responsibilty of \hyperlink{protocolthe-p}{the} derived type to return this information. \item\end{DoxyCompactList}\item 
\hyperlink{classref__ptr}{LsaRef} \hyperlink{classSummaryNetworkLsa_ace7b6056b3f7a16c023284998e5a89c2}{decode} (uint8\_\-t $\ast$buf, size\_\-t \&len) const   throw (InvalidPacket)
\begin{DoxyCompactList}\small\item\em Decode an LSA. \item\end{DoxyCompactList}\item 
bool \hyperlink{classSummaryNetworkLsa_a5edea49e8bf8e8a544668acd8b503590}{encode} ()
\begin{DoxyCompactList}\small\item\em Encode an LSA for transmission. \item\end{DoxyCompactList}\item 
\hypertarget{classSummaryNetworkLsa_a057c901faf218e310fca92e26e33f91c}{
void {\bfseries set\_\-metric} (uint32\_\-t metric)}
\label{classSummaryNetworkLsa_a057c901faf218e310fca92e26e33f91c}

\item 
\hypertarget{classSummaryNetworkLsa_a23f184a0dd581f3878c7d974d69dd4b9}{
uint32\_\-t {\bfseries get\_\-metric} () const }
\label{classSummaryNetworkLsa_a23f184a0dd581f3878c7d974d69dd4b9}

\item 
\hypertarget{classSummaryNetworkLsa_a64f73b031fd93e9de6611c639aeb657b}{
void {\bfseries set\_\-network\_\-mask} (uint32\_\-t network\_\-mask)}
\label{classSummaryNetworkLsa_a64f73b031fd93e9de6611c639aeb657b}

\item 
\hypertarget{classSummaryNetworkLsa_a39fcf139b67c23de52e06ed6c30b6b93}{
uint32\_\-t {\bfseries get\_\-network\_\-mask} () const }
\label{classSummaryNetworkLsa_a39fcf139b67c23de52e06ed6c30b6b93}

\item 
\hypertarget{classSummaryNetworkLsa_a8f54ca4c4497ecfc578a6d396625db78}{
void {\bfseries set\_\-ipv6prefix} (const \hyperlink{classIPv6Prefix}{IPv6Prefix} \&ipv6prefix)}
\label{classSummaryNetworkLsa_a8f54ca4c4497ecfc578a6d396625db78}

\item 
\hypertarget{classSummaryNetworkLsa_a0e098b439a6f9f771960511b5370b8be}{
\hyperlink{classIPv6Prefix}{IPv6Prefix} {\bfseries get\_\-ipv6prefix} () const }
\label{classSummaryNetworkLsa_a0e098b439a6f9f771960511b5370b8be}

\item 
\hypertarget{classSummaryNetworkLsa_a42f19f2ae1ed4ea4486466ed297d2d53}{
const char $\ast$ \hyperlink{classSummaryNetworkLsa_a42f19f2ae1ed4ea4486466ed297d2d53}{name} () const }
\label{classSummaryNetworkLsa_a42f19f2ae1ed4ea4486466ed297d2d53}

\begin{DoxyCompactList}\small\item\em Printable name of this LSA. \item\end{DoxyCompactList}\item 
\hypertarget{classSummaryNetworkLsa_a8e0b98824ba62aaa7c5f41f2ba0297bd}{
string \hyperlink{classSummaryNetworkLsa_a8e0b98824ba62aaa7c5f41f2ba0297bd}{str} () const }
\label{classSummaryNetworkLsa_a8e0b98824ba62aaa7c5f41f2ba0297bd}

\begin{DoxyCompactList}\small\item\em Generate a printable representation. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classSummaryNetworkLsa_aa23fcc9fb677eddd5b274fc680998521}{
static const size\_\-t {\bfseries IPV6\_\-PREFIX\_\-OFFSET} = 28}
\label{classSummaryNetworkLsa_aa23fcc9fb677eddd5b274fc680998521}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classSummaryNetworkLsa_a4f31da47bdf306bf1dde832edc2b3553}{
uint32\_\-t {\bfseries \_\-metric}}
\label{classSummaryNetworkLsa_a4f31da47bdf306bf1dde832edc2b3553}

\item 
\hypertarget{classSummaryNetworkLsa_ad51c304d302684d6ca870b45daf87574}{
uint32\_\-t {\bfseries \_\-network\_\-mask}}
\label{classSummaryNetworkLsa_ad51c304d302684d6ca870b45daf87574}

\item 
\hypertarget{classSummaryNetworkLsa_ada6b89d7be040e1560b04a76f252c9f0}{
\hyperlink{classIPv6Prefix}{IPv6Prefix} {\bfseries \_\-ipv6prefix}}
\label{classSummaryNetworkLsa_ada6b89d7be040e1560b04a76f252c9f0}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
OSPFv2: Summary-\/LSA Type 3 OSPFv3: Inter-\/Area-\/Prefix-\/LSA. 

\subsection{Member Function Documentation}
\hypertarget{classSummaryNetworkLsa_ace7b6056b3f7a16c023284998e5a89c2}{
\index{SummaryNetworkLsa@{SummaryNetworkLsa}!decode@{decode}}
\index{decode@{decode}!SummaryNetworkLsa@{SummaryNetworkLsa}}
\subsubsection[{decode}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Lsa::LsaRef} SummaryNetworkLsa::decode (
\begin{DoxyParamCaption}
\item[{uint8\_\-t $\ast$}]{buf, }
\item[{size\_\-t \&}]{len}
\end{DoxyParamCaption}
) const  throw ({\bf InvalidPacket})\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classSummaryNetworkLsa_ace7b6056b3f7a16c023284998e5a89c2}


Decode an LSA. 


\begin{DoxyParams}{Parameters}
{\em buf} & pointer to buffer. \\
\hline
{\em len} & length of \hyperlink{protocolthe-p}{the} buffer on input set to \hyperlink{protocolthe-p}{the} number of bytes consumed on output.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A reference to an LSA that manages its own memory. 
\end{DoxyReturn}


Implements \hyperlink{classLsa_a2658a7d54d470268138d15938be0f464}{Lsa}.

\hypertarget{classSummaryNetworkLsa_a5edea49e8bf8e8a544668acd8b503590}{
\index{SummaryNetworkLsa@{SummaryNetworkLsa}!encode@{encode}}
\index{encode@{encode}!SummaryNetworkLsa@{SummaryNetworkLsa}}
\subsubsection[{encode}]{\setlength{\rightskip}{0pt plus 5cm}bool SummaryNetworkLsa::encode (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{classSummaryNetworkLsa_a5edea49e8bf8e8a544668acd8b503590}


Encode an LSA for transmission. 

\begin{DoxyReturn}{Returns}
True on success. 
\end{DoxyReturn}


Implements \hyperlink{classLsa_ae3bd3a0bd24ed458cc8ac8d7e91d1c35}{Lsa}.

\hypertarget{classSummaryNetworkLsa_ad7f0194514396d9bb7abf9b0cfef10bf}{
\index{SummaryNetworkLsa@{SummaryNetworkLsa}!get\_\-ls\_\-type@{get\_\-ls\_\-type}}
\index{get\_\-ls\_\-type@{get\_\-ls\_\-type}!SummaryNetworkLsa@{SummaryNetworkLsa}}
\subsubsection[{get\_\-ls\_\-type}]{\setlength{\rightskip}{0pt plus 5cm}uint16\_\-t SummaryNetworkLsa::get\_\-ls\_\-type (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
\label{classSummaryNetworkLsa_ad7f0194514396d9bb7abf9b0cfef10bf}


It is \hyperlink{protocolthe-p}{the} responsibilty of \hyperlink{protocolthe-p}{the} derived type to return this information. 

\begin{DoxyReturn}{Returns}
The type this lsa represents. 
\end{DoxyReturn}


Implements \hyperlink{classLsa_a0dcc648678ac88856635609a17029ae9}{Lsa}.

\hypertarget{classSummaryNetworkLsa_af684818f7a4f7ea3bd535e7c677f2047}{
\index{SummaryNetworkLsa@{SummaryNetworkLsa}!min\_\-length@{min\_\-length}}
\index{min\_\-length@{min\_\-length}!SummaryNetworkLsa@{SummaryNetworkLsa}}
\subsubsection[{min\_\-length}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t SummaryNetworkLsa::min\_\-length (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
\label{classSummaryNetworkLsa_af684818f7a4f7ea3bd535e7c677f2047}
\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} minimum length of a \hyperlink{classSummaryNetworkLsa}{SummaryNetworkLsa}. 
\end{DoxyReturn}


Implements \hyperlink{classLsa_ad3324ea3bfa81ff90d15690c5ccbd1e4}{Lsa}.



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