mirror of
https://github.com/FreeRTOS/coreMQTT
synced 2025-06-01 21:35:53 +08:00
178 lines
8.6 KiB
HTML
178 lines
8.6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>coreMQTT: TransportInterface_t Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="style.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">coreMQTT<span id="projectnumber"> v1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">MQTT 3.1.1 Client Library</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('struct_transport_interface__t.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">TransportInterface_t Struct Reference<div class="ingroups"><a class="el" href="group__mqtt__struct__types.html">Parameter Structures</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The transport layer interface.
|
|
<a href="struct_transport_interface__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="transport__interface_8h_source.html">transport_interface.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a7c34e9b865e2a509306f09c7dfa3699e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mqtt__callback__types.html#gad7e160e4e09fc5943c9e066b34bf387b">TransportRecv_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_transport_interface__t.html#a7c34e9b865e2a509306f09c7dfa3699e">recv</a></td></tr>
|
|
<tr class="separator:a7c34e9b865e2a509306f09c7dfa3699e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01cd9935e9a5266ca196243a0054d489"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mqtt__callback__types.html#ga754f7e7d2e8fa8ba4e961153da195382">TransportSend_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_transport_interface__t.html#a01cd9935e9a5266ca196243a0054d489">send</a></td></tr>
|
|
<tr class="separator:a01cd9935e9a5266ca196243a0054d489"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf4702050bef8d62714a4d3900e95087"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__mqtt__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_transport_interface__t.html#aaf4702050bef8d62714a4d3900e95087">pNetworkContext</a></td></tr>
|
|
<tr class="separator:aaf4702050bef8d62714a4d3900e95087"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >The transport layer interface. </p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a7c34e9b865e2a509306f09c7dfa3699e" name="a7c34e9b865e2a509306f09c7dfa3699e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c34e9b865e2a509306f09c7dfa3699e">◆ </a></span>recv</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__mqtt__callback__types.html#gad7e160e4e09fc5943c9e066b34bf387b">TransportRecv_t</a> TransportInterface_t::recv</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Transport receive interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a01cd9935e9a5266ca196243a0054d489" name="a01cd9935e9a5266ca196243a0054d489"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01cd9935e9a5266ca196243a0054d489">◆ </a></span>send</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__mqtt__callback__types.html#ga754f7e7d2e8fa8ba4e961153da195382">TransportSend_t</a> TransportInterface_t::send</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Transport send interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf4702050bef8d62714a4d3900e95087" name="aaf4702050bef8d62714a4d3900e95087"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf4702050bef8d62714a4d3900e95087">◆ </a></span>pNetworkContext</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__mqtt__struct__types.html#ga7769e434e7811caed8cd6fd7f9ec26ec">NetworkContext_t</a>* TransportInterface_t::pNetworkContext</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Implementation-defined network context. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="transport__interface_8h_source.html">transport_interface.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="struct_transport_interface__t.html">TransportInterface_t</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|