\hypertarget{class_b_m_a_response}{}\section{B\+M\+A\+Response Class Reference}
\label{class_b_m_a_response}\index{B\+M\+A\+Response@{B\+M\+A\+Response}}


{\ttfamily \#include $<$B\+M\+A\+Response.\+h$>$}



Inheritance diagram for B\+M\+A\+Response\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=163pt]{class_b_m_a_response__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for B\+M\+A\+Response\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=163pt]{class_b_m_a_response__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{class_b_m_a_response_a72097d385140286a5cc78258e2e01db1}\label{class_b_m_a_response_a72097d385140286a5cc78258e2e01db1}} 
enum {\bfseries Mode} \{ {\bfseries L\+E\+N\+G\+TH}, 
{\bfseries S\+T\+R\+E\+A\+M\+I\+NG}
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_b_m_a_response_a5894f00cfff7e3acfc0a4f5855ce06d4}{B\+M\+A\+Response} ()
\item 
\hyperlink{class_b_m_a_response_a49a9c247f4a24228999f821ca9ed0f1c}{$\sim$\+B\+M\+A\+Response} ()
\item 
std\+::string \hyperlink{class_b_m_a_response_a4a3cb34b0ae6960e2e128e48ef6d7de0}{get\+Response} (Mode mode)
\item 
std\+::string \hyperlink{class_b_m_a_response_a71d725771b4cc438728d19328cf08753}{get\+Response} (std\+::string content, Mode mode)
\item 
void \hyperlink{class_b_m_a_response_a5526051a488f5f0b47fd6b7880b09cba}{set\+Protocol} (std\+::string protocol)
\item 
void \hyperlink{class_b_m_a_response_a95f7fe1ccd76e3f0fb6d484bb4caca68}{set\+Code} (std\+::string code)
\item 
void \hyperlink{class_b_m_a_response_afec05f85173433e640685154bc11842b}{set\+Text} (std\+::string text)
\item 
void \hyperlink{class_b_m_a_response_ab24318e9036baba9b5b3824509e29a09}{set\+Mime\+Type} (std\+::string mime\+Type)
\item 
\mbox{\Hypertarget{class_b_m_a_response_a43bd15f52defef5d9eaaedf0ed8da71e}\label{class_b_m_a_response_a43bd15f52defef5d9eaaedf0ed8da71e}} 
void {\bfseries add\+Header\+Item} (std\+::string key, std\+::string value)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{class_b_m_a_response}{B\+M\+A\+Response}

Use this object to build a response output for a protocol that uses headers and responses as the main communications protocol. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_b_m_a_response_a5894f00cfff7e3acfc0a4f5855ce06d4}\label{class_b_m_a_response_a5894f00cfff7e3acfc0a4f5855ce06d4}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{B\+M\+A\+Response()}{BMAResponse()}}
{\footnotesize\ttfamily B\+M\+A\+Response\+::\+B\+M\+A\+Response (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

The constructor for the object. \mbox{\Hypertarget{class_b_m_a_response_a49a9c247f4a24228999f821ca9ed0f1c}\label{class_b_m_a_response_a49a9c247f4a24228999f821ca9ed0f1c}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!````~B\+M\+A\+Response@{$\sim$\+B\+M\+A\+Response}}
\index{````~B\+M\+A\+Response@{$\sim$\+B\+M\+A\+Response}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{$\sim$\+B\+M\+A\+Response()}{~BMAResponse()}}
{\footnotesize\ttfamily B\+M\+A\+Response\+::$\sim$\+B\+M\+A\+Response (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

The destructor for the object. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_b_m_a_response_a4a3cb34b0ae6960e2e128e48ef6d7de0}\label{class_b_m_a_response_a4a3cb34b0ae6960e2e128e48ef6d7de0}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!get\+Response@{get\+Response}}
\index{get\+Response@{get\+Response}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{get\+Response()}{getResponse()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily std\+::string B\+M\+A\+Response\+::get\+Response (\begin{DoxyParamCaption}\item[{Mode}]{mode }\end{DoxyParamCaption})}

Returns the response generated from the contained values that do not return a content length. Using this constructor ensures a zero length Content-\/\+Length value.

\begin{DoxyReturn}{Returns}
the complete response string to send to client. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_b_m_a_response_a71d725771b4cc438728d19328cf08753}\label{class_b_m_a_response_a71d725771b4cc438728d19328cf08753}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!get\+Response@{get\+Response}}
\index{get\+Response@{get\+Response}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{get\+Response()}{getResponse()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily std\+::string B\+M\+A\+Response\+::get\+Response (\begin{DoxyParamCaption}\item[{std\+::string}]{content,  }\item[{Mode}]{mode }\end{DoxyParamCaption})}

Returns the response plus the content passed as a parameter.

This method will automatically generate the proper Content-\/\+Length value for the response.


\begin{DoxyParams}{Parameters}
{\em content} & the content that will be provided on the response message to the client.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the complete response string to send to client. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_b_m_a_response_a95f7fe1ccd76e3f0fb6d484bb4caca68}\label{class_b_m_a_response_a95f7fe1ccd76e3f0fb6d484bb4caca68}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!set\+Code@{set\+Code}}
\index{set\+Code@{set\+Code}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{set\+Code()}{setCode()}}
{\footnotesize\ttfamily void B\+M\+A\+Response\+::set\+Code (\begin{DoxyParamCaption}\item[{std\+::string}]{code }\end{DoxyParamCaption})}

Sets the return code value for the response.


\begin{DoxyParams}{Parameters}
{\em code} & the response code value to return in the response. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_b_m_a_response_ab24318e9036baba9b5b3824509e29a09}\label{class_b_m_a_response_ab24318e9036baba9b5b3824509e29a09}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!set\+Mime\+Type@{set\+Mime\+Type}}
\index{set\+Mime\+Type@{set\+Mime\+Type}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{set\+Mime\+Type()}{setMimeType()}}
{\footnotesize\ttfamily void B\+M\+A\+Response\+::set\+Mime\+Type (\begin{DoxyParamCaption}\item[{std\+::string}]{mime\+Type }\end{DoxyParamCaption})}

Specifies the type of data that will be returned in this response.


\begin{DoxyParams}{Parameters}
{\em mime\+Type} & the mime type for the data. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_b_m_a_response_a5526051a488f5f0b47fd6b7880b09cba}\label{class_b_m_a_response_a5526051a488f5f0b47fd6b7880b09cba}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!set\+Protocol@{set\+Protocol}}
\index{set\+Protocol@{set\+Protocol}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{set\+Protocol()}{setProtocol()}}
{\footnotesize\ttfamily void B\+M\+A\+Response\+::set\+Protocol (\begin{DoxyParamCaption}\item[{std\+::string}]{protocol }\end{DoxyParamCaption})}

Sets the protocol value for the response message. The protocol should match the header received.


\begin{DoxyParams}{Parameters}
{\em protocol} & the protocol value to return in response. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_b_m_a_response_afec05f85173433e640685154bc11842b}\label{class_b_m_a_response_afec05f85173433e640685154bc11842b}} 
\index{B\+M\+A\+Response@{B\+M\+A\+Response}!set\+Text@{set\+Text}}
\index{set\+Text@{set\+Text}!B\+M\+A\+Response@{B\+M\+A\+Response}}
\subsubsection{\texorpdfstring{set\+Text()}{setText()}}
{\footnotesize\ttfamily void B\+M\+A\+Response\+::set\+Text (\begin{DoxyParamCaption}\item[{std\+::string}]{text }\end{DoxyParamCaption})}

Sets the return code string value for the response.


\begin{DoxyParams}{Parameters}
{\em text} & the text value for the response code to return on the response. \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
/home/barant/\+Development/\+B\+M\+A/server\+\_\+core/\+Server\+Core/B\+M\+A\+Response.\+h\item 
/home/barant/\+Development/\+B\+M\+A/server\+\_\+core/\+Server\+Core/B\+M\+A\+Response.\+cpp\end{DoxyCompactItemize}
