<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: net_sockets.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">net_sockets.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 "<a class="el" href="config_8h_source.html">config.h</a>"</code><br />
<code>#include "<a class="el" href="ssl_8h_source.html">ssl.h</a>"</code><br />
<code>#include <stddef.h></code><br />
<code>#include <stdint.h></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for net_sockets.h:</div>
<div class="dyncontent">
<div class="center"><img src="net__sockets_8h__incl.png" border="0" usemap="#net__sockets_8h" alt=""/></div>
<map name="net__sockets_8h" id="net__sockets_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__sockets_8h__dep__incl.png" border="0" usemap="#net__sockets_8hdep" alt=""/></div>
<map name="net__sockets_8hdep" id="net__sockets_8hdep">
</map>
</div>
</div>
<p><a href="net__sockets_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa639b33eeaf6414c0de66ab9b8ff6cde"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#aa639b33eeaf6414c0de66ab9b8ff6cde">MBEDTLS_ERR_NET_SOCKET_FAILED</a>   -0x0042</td></tr>
<tr class="separator:aa639b33eeaf6414c0de66ab9b8ff6cde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acdd34e19acf5a23c593895605bf3f219"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#acdd34e19acf5a23c593895605bf3f219">MBEDTLS_ERR_NET_CONNECT_FAILED</a>   -0x0044</td></tr>
<tr class="separator:acdd34e19acf5a23c593895605bf3f219"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4dbd66233b3f8bdd812f388667fcf123"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a4dbd66233b3f8bdd812f388667fcf123">MBEDTLS_ERR_NET_BIND_FAILED</a>   -0x0046</td></tr>
<tr class="separator:a4dbd66233b3f8bdd812f388667fcf123"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bf7cbe6fff470186e4a7a275dde4bdd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a4bf7cbe6fff470186e4a7a275dde4bdd">MBEDTLS_ERR_NET_LISTEN_FAILED</a>   -0x0048</td></tr>
<tr class="separator:a4bf7cbe6fff470186e4a7a275dde4bdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a030cd35e75797c983c61152fd36bd135"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a030cd35e75797c983c61152fd36bd135">MBEDTLS_ERR_NET_ACCEPT_FAILED</a>   -0x004A</td></tr>
<tr class="separator:a030cd35e75797c983c61152fd36bd135"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c95b85b300ddc10a753899ff2f154f2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a0c95b85b300ddc10a753899ff2f154f2">MBEDTLS_ERR_NET_RECV_FAILED</a>   -0x004C</td></tr>
<tr class="separator:a0c95b85b300ddc10a753899ff2f154f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad11d72cca1319fd35fb9e73c9428e92d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#ad11d72cca1319fd35fb9e73c9428e92d">MBEDTLS_ERR_NET_SEND_FAILED</a>   -0x004E</td></tr>
<tr class="separator:ad11d72cca1319fd35fb9e73c9428e92d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1793f099e5c010750c7a07bf259898d9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a1793f099e5c010750c7a07bf259898d9">MBEDTLS_ERR_NET_CONN_RESET</a>   -0x0050</td></tr>
<tr class="separator:a1793f099e5c010750c7a07bf259898d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a937d55e9aa02f1554a43f562a5fc24f9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a937d55e9aa02f1554a43f562a5fc24f9">MBEDTLS_ERR_NET_UNKNOWN_HOST</a>   -0x0052</td></tr>
<tr class="separator:a937d55e9aa02f1554a43f562a5fc24f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a089c6b33dd98bfae43a42ed726cacb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a6a089c6b33dd98bfae43a42ed726cacb">MBEDTLS_ERR_NET_BUFFER_TOO_SMALL</a>   -0x0043</td></tr>
<tr class="separator:a6a089c6b33dd98bfae43a42ed726cacb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a945ec2afc6c9d9d73166ce1e073aaa18"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a945ec2afc6c9d9d73166ce1e073aaa18">MBEDTLS_ERR_NET_INVALID_CONTEXT</a>   -0x0045</td></tr>
<tr class="separator:a945ec2afc6c9d9d73166ce1e073aaa18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28c00c358ccc381ecfc2a28f59db8bd3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a28c00c358ccc381ecfc2a28f59db8bd3">MBEDTLS_NET_LISTEN_BACKLOG</a>   10</td></tr>
<tr class="separator:a28c00c358ccc381ecfc2a28f59db8bd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a989e1bc1aae7e48ac318d5ddd24efa3b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a989e1bc1aae7e48ac318d5ddd24efa3b">MBEDTLS_NET_PROTO_TCP</a>   0</td></tr>
<tr class="separator:a989e1bc1aae7e48ac318d5ddd24efa3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d6d212e9f0ea5756fff8d06c46f4f44"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a8d6d212e9f0ea5756fff8d06c46f4f44">MBEDTLS_NET_PROTO_UDP</a>   1</td></tr>
<tr class="separator:a8d6d212e9f0ea5756fff8d06c46f4f44"><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:aed7458e19fc1b4794f3a23aa3df49543"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#aed7458e19fc1b4794f3a23aa3df49543">mbedtls_net_init</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx)</td></tr>
<tr class="memdesc:aed7458e19fc1b4794f3a23aa3df49543"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a context Just makes the context ready to be used or freed safely. <a href="#aed7458e19fc1b4794f3a23aa3df49543">More...</a><br /></td></tr>
<tr class="separator:aed7458e19fc1b4794f3a23aa3df49543"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac12c400864a5aad46666828ce2a089a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#ac12c400864a5aad46666828ce2a089a4">mbedtls_net_connect</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx, const char *host, const char *port, int proto)</td></tr>
<tr class="memdesc:ac12c400864a5aad46666828ce2a089a4"><td class="mdescLeft"> </td><td class="mdescRight">Initiate a connection with host:port in the given protocol. <a href="#ac12c400864a5aad46666828ce2a089a4">More...</a><br /></td></tr>
<tr class="separator:ac12c400864a5aad46666828ce2a089a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1cb7fc819153c43a2c75c95d0152c75"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#aa1cb7fc819153c43a2c75c95d0152c75">mbedtls_net_bind</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx, const char *bind_ip, const char *port, int proto)</td></tr>
<tr class="memdesc:aa1cb7fc819153c43a2c75c95d0152c75"><td class="mdescLeft"> </td><td class="mdescRight">Create a receiving socket on bind_ip:port in the chosen protocol. If bind_ip == NULL, all interfaces are bound. <a href="#aa1cb7fc819153c43a2c75c95d0152c75">More...</a><br /></td></tr>
<tr class="separator:aa1cb7fc819153c43a2c75c95d0152c75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f862b9086f3466593d5cf399b2c98c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a2f862b9086f3466593d5cf399b2c98c6">mbedtls_net_accept</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *bind_ctx, <a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *client_ctx, void *client_ip, size_t buf_size, size_t *ip_len)</td></tr>
<tr class="memdesc:a2f862b9086f3466593d5cf399b2c98c6"><td class="mdescLeft"> </td><td class="mdescRight">Accept a connection from a remote client. <a href="#a2f862b9086f3466593d5cf399b2c98c6">More...</a><br /></td></tr>
<tr class="separator:a2f862b9086f3466593d5cf399b2c98c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeea4e6fd5ad3167bf8563e61f6f75963"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#aeea4e6fd5ad3167bf8563e61f6f75963">mbedtls_net_set_block</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx)</td></tr>
<tr class="memdesc:aeea4e6fd5ad3167bf8563e61f6f75963"><td class="mdescLeft"> </td><td class="mdescRight">Set the socket blocking. <a href="#aeea4e6fd5ad3167bf8563e61f6f75963">More...</a><br /></td></tr>
<tr class="separator:aeea4e6fd5ad3167bf8563e61f6f75963"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ee4acdc24ef78c9acf5068a423b8c30"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a2ee4acdc24ef78c9acf5068a423b8c30">mbedtls_net_set_nonblock</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx)</td></tr>
<tr class="memdesc:a2ee4acdc24ef78c9acf5068a423b8c30"><td class="mdescLeft"> </td><td class="mdescRight">Set the socket non-blocking. <a href="#a2ee4acdc24ef78c9acf5068a423b8c30">More...</a><br /></td></tr>
<tr class="separator:a2ee4acdc24ef78c9acf5068a423b8c30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716044d3c30c449bd68052b7c418ff84"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a716044d3c30c449bd68052b7c418ff84">mbedtls_net_usleep</a> (unsigned long usec)</td></tr>
<tr class="memdesc:a716044d3c30c449bd68052b7c418ff84"><td class="mdescLeft"> </td><td class="mdescRight">Portable usleep helper. <a href="#a716044d3c30c449bd68052b7c418ff84">More...</a><br /></td></tr>
<tr class="separator:a716044d3c30c449bd68052b7c418ff84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03af351ec420bbeb5e91357abcfb3663"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a03af351ec420bbeb5e91357abcfb3663">mbedtls_net_recv</a> (void *ctx, unsigned char *buf, size_t len)</td></tr>
<tr class="memdesc:a03af351ec420bbeb5e91357abcfb3663"><td class="mdescLeft"> </td><td class="mdescRight">Read at most 'len' characters. If no error occurs, the actual amount read is returned. <a href="#a03af351ec420bbeb5e91357abcfb3663">More...</a><br /></td></tr>
<tr class="separator:a03af351ec420bbeb5e91357abcfb3663"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4841afd0e14f1fd44b82c3a850961ab7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a4841afd0e14f1fd44b82c3a850961ab7">mbedtls_net_send</a> (void *ctx, const unsigned char *buf, size_t len)</td></tr>
<tr class="memdesc:a4841afd0e14f1fd44b82c3a850961ab7"><td class="mdescLeft"> </td><td class="mdescRight">Write at most 'len' characters. If no error occurs, the actual amount read is returned. <a href="#a4841afd0e14f1fd44b82c3a850961ab7">More...</a><br /></td></tr>
<tr class="separator:a4841afd0e14f1fd44b82c3a850961ab7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67810154d2328a80b146155d8cdecfd9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a67810154d2328a80b146155d8cdecfd9">mbedtls_net_recv_timeout</a> (void *ctx, unsigned char *buf, size_t len, uint32_t timeout)</td></tr>
<tr class="memdesc:a67810154d2328a80b146155d8cdecfd9"><td class="mdescLeft"> </td><td class="mdescRight">Read at most 'len' characters, blocking for at most 'timeout' seconds. If no error occurs, the actual amount read is returned. <a href="#a67810154d2328a80b146155d8cdecfd9">More...</a><br /></td></tr>
<tr class="separator:a67810154d2328a80b146155d8cdecfd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77c35cb3f4b9fe6035d1d3742f3b4a24"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="net__sockets_8h.html#a77c35cb3f4b9fe6035d1d3742f3b4a24">mbedtls_net_free</a> (<a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> *ctx)</td></tr>
<tr class="memdesc:a77c35cb3f4b9fe6035d1d3742f3b4a24"><td class="mdescLeft"> </td><td class="mdescRight">Gracefully shutdown the connection and free associated data. <a href="#a77c35cb3f4b9fe6035d1d3742f3b4a24">More...</a><br /></td></tr>
<tr class="separator:a77c35cb3f4b9fe6035d1d3742f3b4a24"><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 class="definition">Definition in file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a030cd35e75797c983c61152fd36bd135"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a030cd35e75797c983c61152fd36bd135">◆ </a></span>MBEDTLS_ERR_NET_ACCEPT_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_ACCEPT_FAILED   -0x004A</td>
</tr>
</table>
</div><div class="memdoc">
<p>Could not accept the incoming connection. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00042">42</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a4dbd66233b3f8bdd812f388667fcf123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dbd66233b3f8bdd812f388667fcf123">◆ </a></span>MBEDTLS_ERR_NET_BIND_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_BIND_FAILED   -0x0046</td>
</tr>
</table>
</div><div class="memdoc">
<p>Binding of the socket failed. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00040">40</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a6a089c6b33dd98bfae43a42ed726cacb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a089c6b33dd98bfae43a42ed726cacb">◆ </a></span>MBEDTLS_ERR_NET_BUFFER_TOO_SMALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL   -0x0043</td>
</tr>
</table>
</div><div class="memdoc">
<p>Buffer is too small to hold the data. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00047">47</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a1793f099e5c010750c7a07bf259898d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1793f099e5c010750c7a07bf259898d9">◆ </a></span>MBEDTLS_ERR_NET_CONN_RESET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_CONN_RESET   -0x0050</td>
</tr>
</table>
</div><div class="memdoc">
<p>Connection was reset by peer. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00045">45</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="acdd34e19acf5a23c593895605bf3f219"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdd34e19acf5a23c593895605bf3f219">◆ </a></span>MBEDTLS_ERR_NET_CONNECT_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_CONNECT_FAILED   -0x0044</td>
</tr>
</table>
</div><div class="memdoc">
<p>The connection to the given server / port failed. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00039">39</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a945ec2afc6c9d9d73166ce1e073aaa18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a945ec2afc6c9d9d73166ce1e073aaa18">◆ </a></span>MBEDTLS_ERR_NET_INVALID_CONTEXT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_INVALID_CONTEXT   -0x0045</td>
</tr>
</table>
</div><div class="memdoc">
<p>The context is invalid, eg because it was free()ed. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00048">48</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a4bf7cbe6fff470186e4a7a275dde4bdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf7cbe6fff470186e4a7a275dde4bdd">◆ </a></span>MBEDTLS_ERR_NET_LISTEN_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_LISTEN_FAILED   -0x0048</td>
</tr>
</table>
</div><div class="memdoc">
<p>Could not listen on the socket. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00041">41</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a0c95b85b300ddc10a753899ff2f154f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c95b85b300ddc10a753899ff2f154f2">◆ </a></span>MBEDTLS_ERR_NET_RECV_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_RECV_FAILED   -0x004C</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reading information from the socket failed. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00043">43</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="ad11d72cca1319fd35fb9e73c9428e92d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad11d72cca1319fd35fb9e73c9428e92d">◆ </a></span>MBEDTLS_ERR_NET_SEND_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_SEND_FAILED   -0x004E</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sending information through the socket failed. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00044">44</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="aa639b33eeaf6414c0de66ab9b8ff6cde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa639b33eeaf6414c0de66ab9b8ff6cde">◆ </a></span>MBEDTLS_ERR_NET_SOCKET_FAILED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_SOCKET_FAILED   -0x0042</td>
</tr>
</table>
</div><div class="memdoc">
<p>Failed to open a socket. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00038">38</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a937d55e9aa02f1554a43f562a5fc24f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a937d55e9aa02f1554a43f562a5fc24f9">◆ </a></span>MBEDTLS_ERR_NET_UNKNOWN_HOST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_ERR_NET_UNKNOWN_HOST   -0x0052</td>
</tr>
</table>
</div><div class="memdoc">
<p>Failed to get an IP address for the given hostname. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00046">46</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a28c00c358ccc381ecfc2a28f59db8bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28c00c358ccc381ecfc2a28f59db8bd3">◆ </a></span>MBEDTLS_NET_LISTEN_BACKLOG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_NET_LISTEN_BACKLOG   10</td>
</tr>
</table>
</div><div class="memdoc">
<p>The backlog that listen() should use. </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00050">50</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a989e1bc1aae7e48ac318d5ddd24efa3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989e1bc1aae7e48ac318d5ddd24efa3b">◆ </a></span>MBEDTLS_NET_PROTO_TCP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_NET_PROTO_TCP   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>The TCP transport protocol </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00052">52</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<a id="a8d6d212e9f0ea5756fff8d06c46f4f44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d6d212e9f0ea5756fff8d06c46f4f44">◆ </a></span>MBEDTLS_NET_PROTO_UDP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_NET_PROTO_UDP   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The UDP transport protocol </p>
<p class="definition">Definition at line <a class="el" href="net__sockets_8h_source.html#l00053">53</a> of file <a class="el" href="net__sockets_8h_source.html">net_sockets.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2f862b9086f3466593d5cf399b2c98c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f862b9086f3466593d5cf399b2c98c6">◆ </a></span>mbedtls_net_accept()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_accept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>bind_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>client_ctx</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 class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>ip_len</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_ctx</td><td>Relevant socket </td></tr>
<tr><td class="paramname">client_ctx</td><td>Will contain the connected client socket </td></tr>
<tr><td class="paramname">client_ip</td><td>Will contain the client IP address, can be NULL </td></tr>
<tr><td class="paramname">buf_size</td><td>Size of the client_ip buffer </td></tr>
<tr><td class="paramname">ip_len</td><td>Will receive the size of the client IP written, can be NULL if client_ip is null</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or MBEDTLS_ERR_NET_ACCEPT_FAILED, or MBEDTLS_ERR_NET_BUFFER_TOO_SMALL if buf_size is too small, MBEDTLS_ERR_SSL_WANT_READ if bind_fd was set to non-blocking and accept() would block. </dd></dl>
</div>
</div>
<a id="aa1cb7fc819153c43a2c75c95d0152c75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1cb7fc819153c43a2c75c95d0152c75">◆ </a></span>mbedtls_net_bind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_bind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</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">const char * </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>proto</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a receiving socket on bind_ip:port in the chosen protocol. If bind_ip == NULL, all interfaces are bound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</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>
<tr><td class="paramname">proto</td><td>Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or one of: MBEDTLS_ERR_NET_SOCKET_FAILED, MBEDTLS_ERR_NET_BIND_FAILED, MBEDTLS_ERR_NET_LISTEN_FAILED</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Regardless of the protocol, opens the sockets and binds it. In addition, make the socket listening if protocol is TCP. </dd></dl>
</div>
</div>
<a id="ac12c400864a5aad46666828ce2a089a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac12c400864a5aad46666828ce2a089a4">◆ </a></span>mbedtls_net_connect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</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">const char * </td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>proto</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initiate a connection with host:port in the given protocol. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</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>
<tr><td class="paramname">proto</td><td>Protocol: MBEDTLS_NET_PROTO_TCP or MBEDTLS_NET_PROTO_UDP</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or one of: MBEDTLS_ERR_NET_SOCKET_FAILED, MBEDTLS_ERR_NET_UNKNOWN_HOST, MBEDTLS_ERR_NET_CONNECT_FAILED</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Sets the socket in connected mode even with UDP. </dd></dl>
</div>
</div>
<a id="a77c35cb3f4b9fe6035d1d3742f3b4a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77c35cb3f4b9fe6035d1d3742f3b4a24">◆ </a></span>mbedtls_net_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_net_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gracefully shutdown the connection and free associated data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>The context to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aed7458e19fc1b4794f3a23aa3df49543"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed7458e19fc1b4794f3a23aa3df49543">◆ </a></span>mbedtls_net_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_net_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a context Just makes the context ready to be used or freed safely. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a03af351ec420bbeb5e91357abcfb3663"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03af351ec420bbeb5e91357abcfb3663">◆ </a></span>mbedtls_net_recv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_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. 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>the number of bytes received, or a non-zero error code; with a non-blocking socket, MBEDTLS_ERR_SSL_WANT_READ indicates read() would block. </dd></dl>
</div>
</div>
<a id="a67810154d2328a80b146155d8cdecfd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67810154d2328a80b146155d8cdecfd9">◆ </a></span>mbedtls_net_recv_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_recv_timeout </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 class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read at most 'len' characters, blocking for at most 'timeout' seconds. 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>
<tr><td class="paramname">timeout</td><td>Maximum number of milliseconds to wait for data 0 means no timeout (wait forever)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes received, or a non-zero error code: MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out, MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function will block (until data becomes available or timeout is reached) even if the socket is set to non-blocking. Handling timeouts with non-blocking reads requires a different strategy. </dd></dl>
</div>
</div>
<a id="a4841afd0e14f1fd44b82c3a850961ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4841afd0e14f1fd44b82c3a850961ab7">◆ </a></span>mbedtls_net_send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_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. 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>the number of bytes sent, or a non-zero error code; with a non-blocking socket, MBEDTLS_ERR_SSL_WANT_WRITE indicates write() would block. </dd></dl>
</div>
</div>
<a id="aeea4e6fd5ad3167bf8563e61f6f75963"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeea4e6fd5ad3167bf8563e61f6f75963">◆ </a></span>mbedtls_net_set_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_set_block </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</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">ctx</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 id="a2ee4acdc24ef78c9acf5068a423b8c30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ee4acdc24ef78c9acf5068a423b8c30">◆ </a></span>mbedtls_net_set_nonblock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_net_set_nonblock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__net__context.html">mbedtls_net_context</a> * </td>
<td class="paramname"><em>ctx</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">ctx</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 id="a716044d3c30c449bd68052b7c418ff84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716044d3c30c449bd68052b7c418ff84">◆ </a></span>mbedtls_net_usleep()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_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 Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
392
