\section{Http\-Transport Class Reference}
\label{classHttpTransport}\index{HttpTransport@{HttpTransport}}
The HTTP transport implementation for SOAP. 


{\tt \#include $<$Http\-Transport.hpp$>$}

Inheritance diagram for Http\-Transport::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classHttpTransport}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Type} 
\begin{CompactList}\small\item\em HTTP category, Only POST is used currently, MPOST is not supported yet.\item\end{CompactList}\end{CompactItemize}
\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf $\sim$Http\-Transport} ()
\begin{CompactList}\small\item\em Create HTTP transport with provided remote address as URL-string, set HTTP category default to POST.\item\end{CompactList}\item 
{\bf Http\-Transport} (std::string \&str\-Url, int secure)
\item 
{\bf Http\-Transport} ({\bf Url} url, int secure)
\item 
bool {\bf Init} ()
\begin{CompactList}\small\item\em Initialize HTTP transport by establishing a channel to the remote end.\item\end{CompactList}\item 
\index{Fini@{Fini}!HttpTransport@{HttpTransport}}\index{HttpTransport@{HttpTransport}!Fini@{Fini}}
void {\bf Fini} ()\label{classHttpTransport_a4}

\item 
bool {\bf Get\-Status} (const std::string \&p\_\-Http\-Packet)
\begin{CompactList}\small\item\em Obtain the status of the HTTP packet validity.\item\end{CompactList}\item 
void {\bf Set\-Property} (const char $\ast$p\_\-Property, const char $\ast$p\_\-Value)
\begin{CompactList}\small\item\em Set properties of HTTP transport such as additional Header fields like SOAPAction.\item\end{CompactList}\item 
const {\bf Transport} \& {\bf operator$>$$>$} (const char $\ast$$\ast$p\-Payload)
\begin{CompactList}\small\item\em Read from a HTTP transport handler and store read payload.\item\end{CompactList}\item 
const {\bf Transport} \& {\bf operator$<$$<$} (const char $\ast$p\_\-Payload)
\begin{CompactList}\small\item\em Write a given payload by using HTTP transport as carrier.\item\end{CompactList}\item 
\index{getBodyLength@{getBodyLength}!HttpTransport@{HttpTransport}}\index{HttpTransport@{HttpTransport}!getBodyLength@{getBodyLength}}
int {\bf get\-Body\-Length} ()\label{classHttpTransport_a9}

\item 
\index{setBodyLength@{setBodyLength}!HttpTransport@{HttpTransport}}\index{HttpTransport@{HttpTransport}!setBodyLength@{setBodyLength}}
void {\bf set\-Body\-Length} (int body\-Length)\label{classHttpTransport_a10}

\item 
\index{getIsHttpHeader@{getIsHttpHeader}!HttpTransport@{HttpTransport}}\index{HttpTransport@{HttpTransport}!getIsHttpHeader@{getIsHttpHeader}}
int {\bf get\-Is\-Http\-Header} ()\label{classHttpTransport_a11}

\end{CompactItemize}


\subsection{Detailed Description}
The HTTP transport implementation for SOAP.

Implements HTTP transport as SOAP-Envelop carrier, for sending/receiving SOAP messages with HTTP 1.1/1.0; This implementation abstract the {\bf Transport} {\rm (p.\,\pageref{classTransport})} layer for the SOAP payloads 



\subsection{Constructor \& Destructor Documentation}
\index{HttpTransport@{Http\-Transport}!~HttpTransport@{$\sim$HttpTransport}}
\index{~HttpTransport@{$\sim$HttpTransport}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Http\-Transport::$\sim$Http\-Transport ()}\label{classHttpTransport_a0}


Create HTTP transport with provided remote address as URL-string, set HTTP category default to POST.

Shutdown any established channel \index{HttpTransport@{Http\-Transport}!HttpTransport@{HttpTransport}}
\index{HttpTransport@{HttpTransport}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Http\-Transport::Http\-Transport (std::string \& {\em str\-Url}, int {\em secure})}\label{classHttpTransport_a1}


Create HTTP transport with provided remote address as URL-string, set HTTP category default to POST \index{HttpTransport@{Http\-Transport}!HttpTransport@{HttpTransport}}
\index{HttpTransport@{HttpTransport}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Http\-Transport::Http\-Transport ({\bf Url} {\em url}, int {\em secure})}\label{classHttpTransport_a2}


Create HTTP transport with provided URL as remote address, set HTTP category default to POST 

\subsection{Member Function Documentation}
\index{HttpTransport@{Http\-Transport}!GetStatus@{GetStatus}}
\index{GetStatus@{GetStatus}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Http\-Transport::Get\-Status (const std::string \& {\em p\_\-Http\-Packet})\hspace{0.3cm}{\tt  [virtual]}}\label{classHttpTransport_a5}


Obtain the status of the HTTP packet validity.

Obtain the status of the HTTP packet validity.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\_\-Http\-Packet}]HTTP packet\end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
Status of the HTTP packet validity. \end{Desc}


Reimplemented from {\bf Transport} {\rm (p.\,\pageref{classTransport})}.\index{HttpTransport@{Http\-Transport}!Init@{Init}}
\index{Init@{Init}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Http\-Transport::Init ()\hspace{0.3cm}{\tt  [virtual]}}\label{classHttpTransport_a3}


Initialize HTTP transport by establishing a channel to the remote end.

Initialize HTTP transport by establishing a channel to the remote end.

\begin{Desc}
\item[Returns: ]\par
Status of the channel establishment to the remote end provided by m\_\-Url @trows {\bf Channel} {\rm (p.\,\pageref{classChannel})} Exception \end{Desc}


Reimplemented from {\bf Transport} {\rm (p.\,\pageref{classTransport})}.\index{HttpTransport@{Http\-Transport}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Transport} \& Http\-Transport::operator$<$$<$ (const char $\ast$ {\em p\_\-Payload})\hspace{0.3cm}{\tt  [virtual]}}\label{classHttpTransport_a8}


Write a given payload by using HTTP transport as carrier.

Write a given payload to the established channel by using HTTP transport as carrier. 

Implements {\bf Transport} {\rm (p.\,\pageref{classTransport})}.\index{HttpTransport@{Http\-Transport}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Transport} \& Http\-Transport::operator$>$$>$ (const char $\ast$$\ast$ {\em p\-Pay\-Load})\hspace{0.3cm}{\tt  [virtual]}}\label{classHttpTransport_a7}


Read from a HTTP transport handler and store read payload.

Read from a HTTP transport handler and store read payload.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\_\-Payload}]SOAP Envelop as Payload for HTTP transport \end{description}
\end{Desc}


Reimplemented from {\bf Transport} {\rm (p.\,\pageref{classTransport})}.\index{HttpTransport@{Http\-Transport}!SetProperty@{SetProperty}}
\index{SetProperty@{SetProperty}!HttpTransport@{Http\-Transport}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Http\-Transport::Set\-Property (const char $\ast$ {\em p\_\-Property}, const char $\ast$ {\em p\_\-Value})\hspace{0.3cm}{\tt  [virtual]}}\label{classHttpTransport_a6}


Set properties of HTTP transport such as additional Header fields like SOAPAction.

Set properties of HTTP transport such as additional Header fields like SOAPAction.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
p\_\-Property}]Property name; such as SOAPAction \item[{\em 
p\_\-Value}]Property value \end{description}
\end{Desc}


Implements {\bf Transport} {\rm (p.\,\pageref{classTransport})}.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
Http\-Transport.hpp\item 
Http\-Transport.cpp\end{CompactItemize}
