<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>PolarSSL v1.3.8: net.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></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>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">net.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Network communication functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for net.h:</div>
<div class="dyncontent">
<div class="center"><img src="net_8h__incl.png" border="0" usemap="#net_8h" alt=""/></div>
<map name="net_8h" id="net_8h">
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="net_8h__dep__incl.png" border="0" usemap="#net_8hdep" alt=""/></div>
<map name="net_8hdep" id="net_8hdep">
</map>
</div>
</div>
<p><a href="net_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8b8dc4d3104b157a2ade8da7831f48f1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a8b8dc4d3104b157a2ade8da7831f48f1">POLARSSL_ERR_NET_UNKNOWN_HOST</a>   -0x0056</td></tr>
<tr class="memdesc:a8b8dc4d3104b157a2ade8da7831f48f1"><td class="mdescLeft"> </td><td class="mdescRight">Failed to get an IP address for the given hostname. <a href="#a8b8dc4d3104b157a2ade8da7831f48f1">More...</a><br/></td></tr>
<tr class="separator:a8b8dc4d3104b157a2ade8da7831f48f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec186e276d741e5aad9d8b4cd7ab0efd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#aec186e276d741e5aad9d8b4cd7ab0efd">POLARSSL_ERR_NET_SOCKET_FAILED</a>   -0x0042</td></tr>
<tr class="memdesc:aec186e276d741e5aad9d8b4cd7ab0efd"><td class="mdescLeft"> </td><td class="mdescRight">Failed to open a socket. <a href="#aec186e276d741e5aad9d8b4cd7ab0efd">More...</a><br/></td></tr>
<tr class="separator:aec186e276d741e5aad9d8b4cd7ab0efd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa316f63c8e1deda24d3ae1d146854474"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#aa316f63c8e1deda24d3ae1d146854474">POLARSSL_ERR_NET_CONNECT_FAILED</a>   -0x0044</td></tr>
<tr class="memdesc:aa316f63c8e1deda24d3ae1d146854474"><td class="mdescLeft"> </td><td class="mdescRight">The connection to the given server / port failed. <a href="#aa316f63c8e1deda24d3ae1d146854474">More...</a><br/></td></tr>
<tr class="separator:aa316f63c8e1deda24d3ae1d146854474"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14395a416f051e26a9918052614b34d8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a14395a416f051e26a9918052614b34d8">POLARSSL_ERR_NET_BIND_FAILED</a>   -0x0046</td></tr>
<tr class="memdesc:a14395a416f051e26a9918052614b34d8"><td class="mdescLeft"> </td><td class="mdescRight">Binding of the socket failed. <a href="#a14395a416f051e26a9918052614b34d8">More...</a><br/></td></tr>
<tr class="separator:a14395a416f051e26a9918052614b34d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a943010f94195f2f283a2b3d6ccea5422"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a943010f94195f2f283a2b3d6ccea5422">POLARSSL_ERR_NET_LISTEN_FAILED</a>   -0x0048</td></tr>
<tr class="memdesc:a943010f94195f2f283a2b3d6ccea5422"><td class="mdescLeft"> </td><td class="mdescRight">Could not listen on the socket. <a href="#a943010f94195f2f283a2b3d6ccea5422">More...</a><br/></td></tr>
<tr class="separator:a943010f94195f2f283a2b3d6ccea5422"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad82bbf5012b60516118c5b85e4a73db9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#ad82bbf5012b60516118c5b85e4a73db9">POLARSSL_ERR_NET_ACCEPT_FAILED</a>   -0x004A</td></tr>
<tr class="memdesc:ad82bbf5012b60516118c5b85e4a73db9"><td class="mdescLeft"> </td><td class="mdescRight">Could not accept the incoming connection. <a href="#ad82bbf5012b60516118c5b85e4a73db9">More...</a><br/></td></tr>
<tr class="separator:ad82bbf5012b60516118c5b85e4a73db9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03130c59c475bf1e8a89cf97c28972c6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a03130c59c475bf1e8a89cf97c28972c6">POLARSSL_ERR_NET_RECV_FAILED</a>   -0x004C</td></tr>
<tr class="memdesc:a03130c59c475bf1e8a89cf97c28972c6"><td class="mdescLeft"> </td><td class="mdescRight">Reading information from the socket failed. <a href="#a03130c59c475bf1e8a89cf97c28972c6">More...</a><br/></td></tr>
<tr class="separator:a03130c59c475bf1e8a89cf97c28972c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a6129076b6fefa2d730b9173710f1fe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a6a6129076b6fefa2d730b9173710f1fe">POLARSSL_ERR_NET_SEND_FAILED</a>   -0x004E</td></tr>
<tr class="memdesc:a6a6129076b6fefa2d730b9173710f1fe"><td class="mdescLeft"> </td><td class="mdescRight">Sending information through the socket failed. <a href="#a6a6129076b6fefa2d730b9173710f1fe">More...</a><br/></td></tr>
<tr class="separator:a6a6129076b6fefa2d730b9173710f1fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab25ddd7b1e424e1168226dd268259360"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#ab25ddd7b1e424e1168226dd268259360">POLARSSL_ERR_NET_CONN_RESET</a>   -0x0050</td></tr>
<tr class="memdesc:ab25ddd7b1e424e1168226dd268259360"><td class="mdescLeft"> </td><td class="mdescRight">Connection was reset by peer. <a href="#ab25ddd7b1e424e1168226dd268259360">More...</a><br/></td></tr>
<tr class="separator:ab25ddd7b1e424e1168226dd268259360"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f74d0f93745d7b4a7d46a6b78c0fb4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a5f74d0f93745d7b4a7d46a6b78c0fb4a">POLARSSL_ERR_NET_WANT_READ</a>   -0x0052</td></tr>
<tr class="memdesc:a5f74d0f93745d7b4a7d46a6b78c0fb4a"><td class="mdescLeft"> </td><td class="mdescRight">Connection requires a read call. <a href="#a5f74d0f93745d7b4a7d46a6b78c0fb4a">More...</a><br/></td></tr>
<tr class="separator:a5f74d0f93745d7b4a7d46a6b78c0fb4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a714269000de1543b4f4a3e8d6622a979"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a714269000de1543b4f4a3e8d6622a979">POLARSSL_ERR_NET_WANT_WRITE</a>   -0x0054</td></tr>
<tr class="memdesc:a714269000de1543b4f4a3e8d6622a979"><td class="mdescLeft"> </td><td class="mdescRight">Connection requires a write call. <a href="#a714269000de1543b4f4a3e8d6622a979">More...</a><br/></td></tr>
<tr class="separator:a714269000de1543b4f4a3e8d6622a979"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc2420949d7ec4d71bc892bcdb9d1875"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#adc2420949d7ec4d71bc892bcdb9d1875">POLARSSL_NET_LISTEN_BACKLOG</a>   10</td></tr>
<tr class="memdesc:adc2420949d7ec4d71bc892bcdb9d1875"><td class="mdescLeft"> </td><td class="mdescRight">The backlog that listen() should use. <a href="#adc2420949d7ec4d71bc892bcdb9d1875">More...</a><br/></td></tr>
<tr class="separator:adc2420949d7ec4d71bc892bcdb9d1875"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a49c549b21517d6f905eb9845224f2773"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a49c549b21517d6f905eb9845224f2773">net_connect</a> (int *fd, const char *host, int port)</td></tr>
<tr class="memdesc:a49c549b21517d6f905eb9845224f2773"><td class="mdescLeft"> </td><td class="mdescRight">Initiate a TCP connection with host:port. <a href="#a49c549b21517d6f905eb9845224f2773">More...</a><br/></td></tr>
<tr class="separator:a49c549b21517d6f905eb9845224f2773"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a070a7665a1c2c3a5dc4d78aeef0f29de"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a070a7665a1c2c3a5dc4d78aeef0f29de">net_bind</a> (int *fd, const char *bind_ip, int port)</td></tr>
<tr class="memdesc:a070a7665a1c2c3a5dc4d78aeef0f29de"><td class="mdescLeft"> </td><td class="mdescRight">Create a listening socket on bind_ip:port. <a href="#a070a7665a1c2c3a5dc4d78aeef0f29de">More...</a><br/></td></tr>
<tr class="separator:a070a7665a1c2c3a5dc4d78aeef0f29de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7c66d2cf24804b92805eb6e598a9763"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#aa7c66d2cf24804b92805eb6e598a9763">net_accept</a> (int bind_fd, int *client_fd, void *client_ip)</td></tr>
<tr class="memdesc:aa7c66d2cf24804b92805eb6e598a9763"><td class="mdescLeft"> </td><td class="mdescRight">Accept a connection from a remote client. <a href="#aa7c66d2cf24804b92805eb6e598a9763">More...</a><br/></td></tr>
<tr class="separator:aa7c66d2cf24804b92805eb6e598a9763"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b9985eaba07798c6f4d655fba05bb1b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a3b9985eaba07798c6f4d655fba05bb1b">net_set_block</a> (int fd)</td></tr>
<tr class="memdesc:a3b9985eaba07798c6f4d655fba05bb1b"><td class="mdescLeft"> </td><td class="mdescRight">Set the socket blocking. <a href="#a3b9985eaba07798c6f4d655fba05bb1b">More...</a><br/></td></tr>
<tr class="separator:a3b9985eaba07798c6f4d655fba05bb1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d15cfb98905e57d9f031a75d4c1dbbb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a8d15cfb98905e57d9f031a75d4c1dbbb">net_set_nonblock</a> (int fd)</td></tr>
<tr class="memdesc:a8d15cfb98905e57d9f031a75d4c1dbbb"><td class="mdescLeft"> </td><td class="mdescRight">Set the socket non-blocking. <a href="#a8d15cfb98905e57d9f031a75d4c1dbbb">More...</a><br/></td></tr>
<tr class="separator:a8d15cfb98905e57d9f031a75d4c1dbbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bcef97961f70e97e4cd9ec3ff16a6a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a2bcef97961f70e97e4cd9ec3ff16a6a6">net_usleep</a> (unsigned long usec)</td></tr>
<tr class="memdesc:a2bcef97961f70e97e4cd9ec3ff16a6a6"><td class="mdescLeft"> </td><td class="mdescRight">Portable usleep helper. <a href="#a2bcef97961f70e97e4cd9ec3ff16a6a6">More...</a><br/></td></tr>
<tr class="separator:a2bcef97961f70e97e4cd9ec3ff16a6a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa76688ccbf03470a6cfc61c025758e9f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#aa76688ccbf03470a6cfc61c025758e9f">net_recv</a> (void *ctx, unsigned char *buf, size_t len)</td></tr>
<tr class="memdesc:aa76688ccbf03470a6cfc61c025758e9f"><td class="mdescLeft"> </td><td class="mdescRight">Read at most 'len' characters. <a href="#aa76688ccbf03470a6cfc61c025758e9f">More...</a><br/></td></tr>
<tr class="separator:aa76688ccbf03470a6cfc61c025758e9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab14d74cc7497b93580c6a6ddb7c77561"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#ab14d74cc7497b93580c6a6ddb7c77561">net_send</a> (void *ctx, const unsigned char *buf, size_t len)</td></tr>
<tr class="memdesc:ab14d74cc7497b93580c6a6ddb7c77561"><td class="mdescLeft"> </td><td class="mdescRight">Write at most 'len' characters. <a href="#ab14d74cc7497b93580c6a6ddb7c77561">More...</a><br/></td></tr>
<tr class="separator:ab14d74cc7497b93580c6a6ddb7c77561"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0cf7ff43e2f8edb76e2f4724732cc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net_8h.html#a1b0cf7ff43e2f8edb76e2f4724732cc6">net_close</a> (int fd)</td></tr>
<tr class="memdesc:a1b0cf7ff43e2f8edb76e2f4724732cc6"><td class="mdescLeft"> </td><td class="mdescRight">Gracefully shutdown the connection. <a href="#a1b0cf7ff43e2f8edb76e2f4724732cc6">More...</a><br/></td></tr>
<tr class="separator:a1b0cf7ff43e2f8edb76e2f4724732cc6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Network communication functions. </p>
<p>Copyright (C) 2006-2011, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ad82bbf5012b60516118c5b85e4a73db9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_ACCEPT_FAILED   -0x004A</td>
</tr>
</table>
</div><div class="memdoc">
<p>Could not accept the incoming connection. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00037">37</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a14395a416f051e26a9918052614b34d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_BIND_FAILED   -0x0046</td>
</tr>
</table>
</div><div class="memdoc">
<p>Binding of the socket failed. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00035">35</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab25ddd7b1e424e1168226dd268259360"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_CONN_RESET   -0x0050</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection was reset by peer. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00040">40</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa316f63c8e1deda24d3ae1d146854474"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_CONNECT_FAILED   -0x0044</td>
</tr>
</table>
</div><div class="memdoc">
<p>The connection to the given server / port failed. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00034">34</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a943010f94195f2f283a2b3d6ccea5422"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_LISTEN_FAILED   -0x0048</td>
</tr>
</table>
</div><div class="memdoc">
<p>Could not listen on the socket. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00036">36</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a03130c59c475bf1e8a89cf97c28972c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_RECV_FAILED   -0x004C</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reading information from the socket failed. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00038">38</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6a6129076b6fefa2d730b9173710f1fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_SEND_FAILED   -0x004E</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sending information through the socket failed. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00039">39</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="aec186e276d741e5aad9d8b4cd7ab0efd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_SOCKET_FAILED   -0x0042</td>
</tr>
</table>
</div><div class="memdoc">
<p>Failed to open a socket. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00033">33</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8b8dc4d3104b157a2ade8da7831f48f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_UNKNOWN_HOST   -0x0056</td>
</tr>
</table>
</div><div class="memdoc">
<p>Failed to get an IP address for the given hostname. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00032">32</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5f74d0f93745d7b4a7d46a6b78c0fb4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_WANT_READ   -0x0052</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection requires a read call. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00041">41</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="a714269000de1543b4f4a3e8d6622a979"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_ERR_NET_WANT_WRITE   -0x0054</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection requires a write call. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00042">42</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<a class="anchor" id="adc2420949d7ec4d71bc892bcdb9d1875"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_NET_LISTEN_BACKLOG   10</td>
</tr>
</table>
</div><div class="memdoc">
<p>The backlog that listen() should use. </p>
<p>Definition at line <a class="el" href="net_8h_source.html#l00044">44</a> of file <a class="el" href="net_8h_source.html">net.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa7c66d2cf24804b92805eb6e598a9763"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_accept </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>bind_fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>client_fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>client_ip</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Accept a connection from a remote client. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bind_fd</td><td>Relevant socket </td></tr>
<tr><td class="paramname">client_fd</td><td>Will contain the connected client socket </td></tr>
<tr><td class="paramname">client_ip</td><td>Will contain the client IP address Must be at least 4 bytes, or 16 if IPv6 is supported</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, POLARSSL_ERR_NET_ACCEPT_FAILED, or POLARSSL_ERR_NET_WANT_READ is bind_fd was set to non-blocking and accept() is blocking. </dd></dl>
</div>
</div>
<a class="anchor" id="a070a7665a1c2c3a5dc4d78aeef0f29de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_bind </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>bind_ip</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a listening socket on bind_ip:port. </p>
<pre class="fragment"> If bind_ip == NULL, all interfaces are binded.
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>Socket to use </td></tr>
<tr><td class="paramname">bind_ip</td><td>IP to bind to, can be NULL </td></tr>
<tr><td class="paramname">port</td><td>Port number to use</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or one of: POLARSSL_ERR_NET_SOCKET_FAILED, POLARSSL_ERR_NET_BIND_FAILED, POLARSSL_ERR_NET_LISTEN_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="a1b0cf7ff43e2f8edb76e2f4724732cc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void net_close </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gracefully shutdown the connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The socket to close </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a49c549b21517d6f905eb9845224f2773"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_connect </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initiate a TCP connection with host:port. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>Socket to use </td></tr>
<tr><td class="paramname">host</td><td>Host to connect to </td></tr>
<tr><td class="paramname">port</td><td>Port to connect to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or one of: POLARSSL_ERR_NET_SOCKET_FAILED, POLARSSL_ERR_NET_UNKNOWN_HOST, POLARSSL_ERR_NET_CONNECT_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="aa76688ccbf03470a6cfc61c025758e9f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_recv </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read at most 'len' characters. </p>
<p>If no error occurs, the actual amount read is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Socket </td></tr>
<tr><td class="paramname">buf</td><td>The buffer to write to </td></tr>
<tr><td class="paramname">len</td><td>Maximum length of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of bytes received, or a non-zero error code; POLARSSL_ERR_NET_WANT_READ indicates read() is blocking. </dd></dl>
</div>
</div>
<a class="anchor" id="ab14d74cc7497b93580c6a6ddb7c77561"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_send </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write at most 'len' characters. </p>
<p>If no error occurs, the actual amount read is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Socket </td></tr>
<tr><td class="paramname">buf</td><td>The buffer to read from </td></tr>
<tr><td class="paramname">len</td><td>The length of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of bytes sent, or a non-zero error code; POLARSSL_ERR_NET_WANT_WRITE indicates write() is blocking. </dd></dl>
</div>
</div>
<a class="anchor" id="a3b9985eaba07798c6f4d655fba05bb1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_set_block </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the socket blocking. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>Socket to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a non-zero error code </dd></dl>
</div>
</div>
<a class="anchor" id="a8d15cfb98905e57d9f031a75d4c1dbbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net_set_nonblock </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the socket non-blocking. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>Socket to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a non-zero error code </dd></dl>
</div>
</div>
<a class="anchor" id="a2bcef97961f70e97e4cd9ec3ff16a6a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void net_usleep </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>usec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Portable usleep helper. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">usec</td><td>Amount of microseconds to sleep</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Real amount of time slept will not be less than select()'s timeout granularity (typically, 10ms). </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
