<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>net_utils.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">net_utils.h</div> </div>
</div>
<div class="contents">
<a href="net__utils_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef MRPT_NET_UTILS_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define MRPT_NET_UTILS_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_client_t_c_p_socket_8h.html">mrpt/utils/CClientTCPSocket.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_c_server_t_c_p_socket_8h.html">mrpt/utils/CServerTCPSocket.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="_t_parameters_8h.html">mrpt/utils/TParameters.h</a>></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>mrpt
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">namespace </span>utils
<a name="l00038"></a>00038 {<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** A set of useful routines for networking.</span>
<a name="l00040"></a>00040 <span class="comment"> * \ingroup network_grp</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a><a class="code" href="namespacemrpt_1_1utils_1_1net.html">00042</a> <span class="keyword">namespace </span>net
<a name="l00043"></a>00043 {<span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment"> /** \addtogroup network_grp</span>
<a name="l00045"></a>00045 <span class="comment"> * @{ */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">using</span> std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a>;
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment"> /** Possible returns from a HTTP request.</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a><a class="code" href="group__network__grp.html#ga3298f4cac6683e3592549ea01e116af6">00051</a> <span class="keyword">enum</span> <a class="code" href="group__network__grp.html#ga3298f4cac6683e3592549ea01e116af6" title="Possible returns from a HTTP request.">ERRORCODE_HTTP</a> {
<a name="l00052"></a><a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a3ec06dcf3bcbc7a44b5d89c9039c6998">00052</a> <a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a3ec06dcf3bcbc7a44b5d89c9039c6998">erOk</a> = 0,
<a name="l00053"></a><a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a918213e1bb1a3a50a0377c7b0ce172bf">00053</a> <a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a918213e1bb1a3a50a0377c7b0ce172bf">erBadURL</a>,
<a name="l00054"></a><a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a9257245834571d1f88e8aa19f5cf7af3">00054</a> <a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a9257245834571d1f88e8aa19f5cf7af3">erCouldntConnect</a>,
<a name="l00055"></a><a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a58245c8e0e5ede3433741ca5d0d1527c">00055</a> <a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6a58245c8e0e5ede3433741ca5d0d1527c">erNotFound</a>,
<a name="l00056"></a><a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6ad2983ad09237d1b2b64568f9ea7052c4">00056</a> <a class="code" href="group__network__grp.html#gga3298f4cac6683e3592549ea01e116af6ad2983ad09237d1b2b64568f9ea7052c4">erOtherHTTPError</a>
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** Perform an HTTP GET operation (version for retrieving the data as a vector_byte)</span>
<a name="l00060"></a>00060 <span class="comment"> * \param url Must be a simple string of the form "http://<servername>/<relative-address>".</span>
<a name="l00061"></a>00061 <span class="comment"> * \param port The server port, if different from 80.</span>
<a name="l00062"></a>00062 <span class="comment"> * \param extra_headers If provided, the given extra HTTP headers will be sent.</span>
<a name="l00063"></a>00063 <span class="comment"> * \param out_errormsg On exit will contain a description of the error or "Ok".</span>
<a name="l00064"></a>00064 <span class="comment"> * \param out_content The buffer with the retrieved data.</span>
<a name="l00065"></a>00065 <span class="comment"> * \param out_http_responsecode If provided, will hold the HTTP code, eg: 200, 404...</span>
<a name="l00066"></a>00066 <span class="comment"> * \param out_headers If provided, a copy of all the headers returned by the server will be saved here.</span>
<a name="l00067"></a>00067 <span class="comment"> * \param auth_user Send a basic HTTP authorization request with the given user & password.</span>
<a name="l00068"></a>00068 <span class="comment"> * \param auth_pass Send a basic HTTP authorization request with the given user & password.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * \return The error or success code.</span>
<a name="l00071"></a>00071 <span class="comment"> * \sa mrpt::utils::vectorToBinaryFile</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a>00073 <a class="code" href="group__network__grp.html#ga3298f4cac6683e3592549ea01e116af6" title="Possible returns from a HTTP request.">ERRORCODE_HTTP</a> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a>
<a name="l00074"></a>00074 <a class="code" href="group__network__grp.html#gad39ce8450e55887628066c72add9345d" title="Perform an HTTP GET operation (version for retrieving the data as a vector_byte)">http_get</a>(
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">string</span> &url,
<a name="l00076"></a>00076 <a class="code" href="classstd_1_1vector.html" title="STL class.">vector_byte</a> &out_content,
<a name="l00077"></a>00077 <span class="keywordtype">string</span> &out_errormsg,
<a name="l00078"></a>00078 <span class="keywordtype">int</span> port = 80,
<a name="l00079"></a>00079 <span class="keyword">const</span> <span class="keywordtype">string</span> &auth_user = <span class="keywordtype">string</span>(),
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">string</span> &auth_pass = <span class="keywordtype">string</span>(),
<a name="l00081"></a>00081 <span class="keywordtype">int</span> *out_http_responsecode = NULL,
<a name="l00082"></a>00082 <a class="code" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters<string></a> *extra_headers = NULL,
<a name="l00083"></a>00083 <a class="code" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters<string></a> *out_headers = NULL,
<a name="l00084"></a>00084 <span class="keywordtype">int</span> timeout_ms = 1000
<a name="l00085"></a>00085 );
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /** Perform an HTTP GET operation (version for retrieving the data as text)</span>
<a name="l00088"></a>00088 <span class="comment"> * \param url Must be a simple string of the form "http://<servername>/<relative-address>".</span>
<a name="l00089"></a>00089 <span class="comment"> * \param port The server port, if different from 80.</span>
<a name="l00090"></a>00090 <span class="comment"> * \param extra_headers If provided, the given extra HTTP headers will be sent.</span>
<a name="l00091"></a>00091 <span class="comment"> * \param out_errormsg On exit will contain a description of the error or "Ok".</span>
<a name="l00092"></a>00092 <span class="comment"> * \param out_content The buffer with the retrieved data.</span>
<a name="l00093"></a>00093 <span class="comment"> * \param out_http_responsecode If provided, will hold the HTTP code, eg: 200, 404...</span>
<a name="l00094"></a>00094 <span class="comment"> * \param out_headers If provided, a copy of all the headers returned by the server will be saved here.</span>
<a name="l00095"></a>00095 <span class="comment"> * \param auth_user Send a basic HTTP authorization request with the given user & password.</span>
<a name="l00096"></a>00096 <span class="comment"> * \param auth_pass Send a basic HTTP authorization request with the given user & password.</span>
<a name="l00097"></a>00097 <span class="comment"> *</span>
<a name="l00098"></a>00098 <span class="comment"> * \return The error or success code.</span>
<a name="l00099"></a>00099 <span class="comment"> * \sa mrpt::utils::vectorToBinaryFile</span>
<a name="l00100"></a>00100 <span class="comment"> */</span>
<a name="l00101"></a>00101 <a class="code" href="group__network__grp.html#ga3298f4cac6683e3592549ea01e116af6" title="Possible returns from a HTTP request.">ERRORCODE_HTTP</a> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a>
<a name="l00102"></a>00102 <a class="code" href="group__network__grp.html#gad39ce8450e55887628066c72add9345d" title="Perform an HTTP GET operation (version for retrieving the data as a vector_byte)">http_get</a>(
<a name="l00103"></a>00103 <span class="keyword">const</span> <span class="keywordtype">string</span> &url,
<a name="l00104"></a>00104 <span class="keywordtype">string</span> &out_content,
<a name="l00105"></a>00105 <span class="keywordtype">string</span> &out_errormsg,
<a name="l00106"></a>00106 <span class="keywordtype">int</span> port = 80,
<a name="l00107"></a>00107 <span class="keyword">const</span> <span class="keywordtype">string</span> &auth_user = <span class="keywordtype">string</span>(),
<a name="l00108"></a>00108 <span class="keyword">const</span> <span class="keywordtype">string</span> &auth_pass = <span class="keywordtype">string</span>(),
<a name="l00109"></a>00109 <span class="keywordtype">int</span> *out_http_responsecode = NULL,
<a name="l00110"></a>00110 <a class="code" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters<string></a> *extra_headers = NULL,
<a name="l00111"></a>00111 <a class="code" href="structmrpt_1_1utils_1_1_t_parameters.html" title="For usage when passing a dynamic number of (numeric) arguments to a function, by name.">mrpt::utils::TParameters<string></a> *out_headers = NULL,
<a name="l00112"></a>00112 <span class="keywordtype">int</span> timeout_ms = 1000
<a name="l00113"></a>00113 );
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /** Resolve a server address by its name, returning its IP address as a string - This method has a timeout for the maximum time to wait for the DNS server.</span>
<a name="l00117"></a>00117 <span class="comment"> * For example: server_name="www.google.com" -> out_ip="209.85.227.99"</span>
<a name="l00118"></a>00118 <span class="comment"> *</span>
<a name="l00119"></a>00119 <span class="comment"> * \return true on success, false on timeout or other error.</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keywordtype">bool</span> <a class="code" href="group__network__grp.html#ga7fcf57ef73acb52f5423ccc4384bd7e4" title="Resolve a server address by its name, returning its IP address as a string - This method has a timeou...">DNS_resolve_async</a>(
<a name="l00122"></a>00122 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &server_name,
<a name="l00123"></a>00123 <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &out_ip,
<a name="l00124"></a>00124 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout_ms = 3000
<a name="l00125"></a>00125 );
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment"> /** @} */</span> <span class="comment">// end grouping</span>
<a name="l00128"></a>00128
<a name="l00129"></a>00129 } <span class="comment">// End of namespace</span>
<a name="l00130"></a>00130 } <span class="comment">// End of namespace</span>
<a name="l00131"></a>00131 } <span class="comment">// end of namespace</span>
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
