\hypertarget{classcore_1_1_response}{}\section{core\+:\+:Response Class Reference}
\label{classcore_1_1_response}\index{core\+::\+Response@{core\+::\+Response}}


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



Inheritance diagram for core\+:\+:Response\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=166pt]{classcore_1_1_response__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for core\+:\+:Response\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=166pt]{classcore_1_1_response__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classcore_1_1_response_a3b75626cd8c189331abd36e14fefe8db}\label{classcore_1_1_response_a3b75626cd8c189331abd36e14fefe8db}} 
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{classcore_1_1_response_a6a73c7153468fc60735ac949ce8bb48b}{Response} ()
\item 
\hyperlink{classcore_1_1_response_aba144a517ada3fe308e663bed08c8b0d}{$\sim$\+Response} ()
\item 
std\+::string \hyperlink{classcore_1_1_response_a49af564b8dbb0389a47906f5cca800cf}{get\+Response} (Mode mode=L\+E\+N\+G\+TH)
\item 
std\+::string \hyperlink{classcore_1_1_response_aedc510111b4c7cc2ed23bb7b107c068a}{get\+Response} (std\+::string content, Mode mode=L\+E\+N\+G\+TH)
\item 
void \hyperlink{classcore_1_1_response_a8d1be083101d3bc36c2f55c4db4b2964}{set\+Protocol} (std\+::string protocol)
\item 
void \hyperlink{classcore_1_1_response_ade8a31ad71a7e82a395c6efb668edfe1}{set\+Code} (std\+::string code)
\item 
void \hyperlink{classcore_1_1_response_a1fc143168d375a858bcbaa36aa10c471}{set\+Text} (std\+::string text)
\item 
void \hyperlink{classcore_1_1_response_ab647c043f771931e50fc0ef5979c6534}{set\+Mime\+Type} (std\+::string mime\+Type)
\item 
\mbox{\Hypertarget{classcore_1_1_response_ad8c1415f5dd9b18c4f92ed307b853397}\label{classcore_1_1_response_ad8c1415f5dd9b18c4f92ed307b853397}} 
void {\bfseries add\+Header\+Item} (std\+::string key, std\+::string value)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{classcore_1_1_response}{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{classcore_1_1_response_a6a73c7153468fc60735ac949ce8bb48b}\label{classcore_1_1_response_a6a73c7153468fc60735ac949ce8bb48b}} 
\index{core\+::\+Response@{core\+::\+Response}!Response@{Response}}
\index{Response@{Response}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{Response()}{Response()}}
{\footnotesize\ttfamily core\+::\+Response\+::\+Response (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

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

The destructor for the object. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1_response_a49af564b8dbb0389a47906f5cca800cf}\label{classcore_1_1_response_a49af564b8dbb0389a47906f5cca800cf}} 
\index{core\+::\+Response@{core\+::\+Response}!get\+Response@{get\+Response}}
\index{get\+Response@{get\+Response}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{get\+Response()}{getResponse()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily std\+::string core\+::\+Response\+::get\+Response (\begin{DoxyParamCaption}\item[{Mode}]{mode = {\ttfamily LENGTH} }\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{classcore_1_1_response_aedc510111b4c7cc2ed23bb7b107c068a}\label{classcore_1_1_response_aedc510111b4c7cc2ed23bb7b107c068a}} 
\index{core\+::\+Response@{core\+::\+Response}!get\+Response@{get\+Response}}
\index{get\+Response@{get\+Response}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{get\+Response()}{getResponse()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily std\+::string core\+::\+Response\+::get\+Response (\begin{DoxyParamCaption}\item[{std\+::string}]{content,  }\item[{Mode}]{mode = {\ttfamily LENGTH} }\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{classcore_1_1_response_ade8a31ad71a7e82a395c6efb668edfe1}\label{classcore_1_1_response_ade8a31ad71a7e82a395c6efb668edfe1}} 
\index{core\+::\+Response@{core\+::\+Response}!set\+Code@{set\+Code}}
\index{set\+Code@{set\+Code}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{set\+Code()}{setCode()}}
{\footnotesize\ttfamily void core\+::\+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{classcore_1_1_response_ab647c043f771931e50fc0ef5979c6534}\label{classcore_1_1_response_ab647c043f771931e50fc0ef5979c6534}} 
\index{core\+::\+Response@{core\+::\+Response}!set\+Mime\+Type@{set\+Mime\+Type}}
\index{set\+Mime\+Type@{set\+Mime\+Type}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{set\+Mime\+Type()}{setMimeType()}}
{\footnotesize\ttfamily void core\+::\+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{classcore_1_1_response_a8d1be083101d3bc36c2f55c4db4b2964}\label{classcore_1_1_response_a8d1be083101d3bc36c2f55c4db4b2964}} 
\index{core\+::\+Response@{core\+::\+Response}!set\+Protocol@{set\+Protocol}}
\index{set\+Protocol@{set\+Protocol}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{set\+Protocol()}{setProtocol()}}
{\footnotesize\ttfamily void core\+::\+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{classcore_1_1_response_a1fc143168d375a858bcbaa36aa10c471}\label{classcore_1_1_response_a1fc143168d375a858bcbaa36aa10c471}} 
\index{core\+::\+Response@{core\+::\+Response}!set\+Text@{set\+Text}}
\index{set\+Text@{set\+Text}!core\+::\+Response@{core\+::\+Response}}
\subsubsection{\texorpdfstring{set\+Text()}{setText()}}
{\footnotesize\ttfamily void core\+::\+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/Response.\+h\item 
/home/barant/\+Development/\+B\+M\+A/server\+\_\+core/\+Server\+Core/Response.\+cpp\end{DoxyCompactItemize}
