mirror of
https://github.com/jialexd/sdk-ameba-v4.0c_180328.git
synced 2024-11-22 14:04:20 +00:00
344 lines
35 KiB
HTML
Executable file
344 lines
35 KiB
HTML
Executable file
<!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.11"/>
|
|
<title>SDK3.5: sn_coap_header.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="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">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">SDK3.5
|
|
</div>
|
|
<div id="projectbrief">This document shows Ameba SDK 3.5 APIs</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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="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>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
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.png" alt=""/></a>
|
|
</span>
|
|
</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>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_59865070466a2d887ccae359ce349522.html">sdk-ameba</a></li><li class="navelem"><a class="el" href="dir_da6bad2e2c5a50fa6b6edae596f8e89f.html">component</a></li><li class="navelem"><a class="el" href="dir_407195b71e2fda49d4a285654b5b25b9.html">common</a></li><li class="navelem"><a class="el" href="dir_199fc8db423d23fe221af67c9b9ab28d.html">network</a></li><li class="navelem"><a class="el" href="dir_343c3b8af3990974a3d33eb9b8a837fd.html">coap</a></li><li class="navelem"><a class="el" href="dir_00077fbb335f4b3b1e31593233038958.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sn_coap_header.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>CoAP C-library User header interface header file.
|
|
<a href="#details">More...</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="structsn__coap__options__list__.html">sn_coap_options_list_</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for CoAP Options. <a href="structsn__coap__options__list__.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsn__coap__hdr__.html">sn_coap_hdr_</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Main CoAP message struct. <a href="structsn__coap__hdr__.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structregistration__info__.html">registration_info_</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Used for creating manually registration message with sn_coap_register() <a href="structregistration__info__.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsn__nsdl__addr__.html">sn_nsdl_addr_</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Address structure of Packet data. <a href="structsn__nsdl__addr__.html#details">More...</a><br /></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="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gaf9efd1fa3a3c58bcddcd8e5f5a09b032"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#gac948c83575959f22cd87b02c247ae9f5">coap_version_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gaf9efd1fa3a3c58bcddcd8e5f5a09b032">coap_version_e</a></td></tr>
|
|
<tr class="memdesc:gaf9efd1fa3a3c58bcddcd8e5f5a09b032"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Version. <br /></td></tr>
|
|
<tr class="separator:gaf9efd1fa3a3c58bcddcd8e5f5a09b032"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6ddd2da009bf86ad83f64019081ac34c"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#gae1614153357c1121ce822a00b2c2293d">sn_coap_msg_type_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga6ddd2da009bf86ad83f64019081ac34c">sn_coap_msg_type_e</a></td></tr>
|
|
<tr class="memdesc:ga6ddd2da009bf86ad83f64019081ac34c"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Message type, used in CoAP Header. <br /></td></tr>
|
|
<tr class="separator:ga6ddd2da009bf86ad83f64019081ac34c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac2c8c7417036ee77465e5177962d0455"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#gafbdc8dd70f66bbece00badf805d1434d">sn_coap_msg_code_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gac2c8c7417036ee77465e5177962d0455">sn_coap_msg_code_e</a></td></tr>
|
|
<tr class="memdesc:gac2c8c7417036ee77465e5177962d0455"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Message code, used in CoAP Header. <br /></td></tr>
|
|
<tr class="separator:gac2c8c7417036ee77465e5177962d0455"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga39c901eafd2f2a8be47daf18aeb14e24"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#ga7e1857c6ffb73e3ef14968ad0d95a2a5">sn_coap_option_numbers_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga39c901eafd2f2a8be47daf18aeb14e24">sn_coap_option_numbers_e</a></td></tr>
|
|
<tr class="memdesc:ga39c901eafd2f2a8be47daf18aeb14e24"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Option number, used in CoAP Header. <br /></td></tr>
|
|
<tr class="separator:ga39c901eafd2f2a8be47daf18aeb14e24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab63aed79b7d1cc8db38c45a255bf37f2"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#ga59684aa6c35b020f309d037d4b2e30a1">sn_coap_content_format_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gab63aed79b7d1cc8db38c45a255bf37f2">sn_coap_content_format_e</a></td></tr>
|
|
<tr class="memdesc:gab63aed79b7d1cc8db38c45a255bf37f2"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Content Format codes. <br /></td></tr>
|
|
<tr class="separator:gab63aed79b7d1cc8db38c45a255bf37f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaddfd3452795ee13c4603613d93092f96"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coap.html#ga4812fa835aae48adb994af470461260d">sn_coap_observe_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gaddfd3452795ee13c4603613d93092f96">sn_coap_observe_e</a></td></tr>
|
|
<tr class="memdesc:gaddfd3452795ee13c4603613d93092f96"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Observe option values. <a href="group__coap.html#gaddfd3452795ee13c4603613d93092f96">More...</a><br /></td></tr>
|
|
<tr class="separator:gaddfd3452795ee13c4603613d93092f96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5785cc0fe52acd232ed0e07fe561f997"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#ga694d02e174302d5eb033a144d8bec7b6">sn_coap_status_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga5785cc0fe52acd232ed0e07fe561f997">sn_coap_status_e</a></td></tr>
|
|
<tr class="memdesc:ga5785cc0fe52acd232ed0e07fe561f997"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP status, used in CoAP Header. <br /></td></tr>
|
|
<tr class="separator:ga5785cc0fe52acd232ed0e07fe561f997"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga53d117b7c5da476f085e72ff4dfa1e39"><td class="memItemLeft" align="right" valign="top">
|
|
typedef struct <a class="el" href="structsn__coap__options__list__.html">sn_coap_options_list_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga53d117b7c5da476f085e72ff4dfa1e39">sn_coap_options_list_s</a></td></tr>
|
|
<tr class="memdesc:ga53d117b7c5da476f085e72ff4dfa1e39"><td class="mdescLeft"> </td><td class="mdescRight">Structure for CoAP Options. <br /></td></tr>
|
|
<tr class="separator:ga53d117b7c5da476f085e72ff4dfa1e39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3a52e89139fbb21b93186618be191a04"><td class="memItemLeft" align="right" valign="top">
|
|
typedef struct <a class="el" href="structsn__coap__hdr__.html">sn_coap_hdr_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a></td></tr>
|
|
<tr class="memdesc:ga3a52e89139fbb21b93186618be191a04"><td class="mdescLeft"> </td><td class="mdescRight">Main CoAP message struct. <br /></td></tr>
|
|
<tr class="separator:ga3a52e89139fbb21b93186618be191a04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7dc4870bb660d8db3b82af03b9c0ecd8"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#ga0969492dc63242b2aa3946d0a79f756b">sn_nsdl_capab_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga7dc4870bb660d8db3b82af03b9c0ecd8">sn_nsdl_capab_e</a></td></tr>
|
|
<tr class="memdesc:ga7dc4870bb660d8db3b82af03b9c0ecd8"><td class="mdescLeft"> </td><td class="mdescRight">Used protocol. <br /></td></tr>
|
|
<tr class="separator:ga7dc4870bb660d8db3b82af03b9c0ecd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2ec704f029f841977a9765988000e0e0"><td class="memItemLeft" align="right" valign="top">
|
|
typedef struct <a class="el" href="structregistration__info__.html">registration_info_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga2ec704f029f841977a9765988000e0e0">registration_info_t</a></td></tr>
|
|
<tr class="memdesc:ga2ec704f029f841977a9765988000e0e0"><td class="mdescLeft"> </td><td class="mdescRight">Used for creating manually registration message with sn_coap_register() <br /></td></tr>
|
|
<tr class="separator:ga2ec704f029f841977a9765988000e0e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafd0cd7bf47eba289f9a04873c0d60a16"><td class="memItemLeft" align="right" valign="top">
|
|
typedef enum <a class="el" href="group__coap.html#gaa79e2f954a9a6b14f564e1f428f618fe">sn_nsdl_addr_type_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gafd0cd7bf47eba289f9a04873c0d60a16">sn_nsdl_addr_type_e</a></td></tr>
|
|
<tr class="memdesc:gafd0cd7bf47eba289f9a04873c0d60a16"><td class="mdescLeft"> </td><td class="mdescRight">Address type of given address. <br /></td></tr>
|
|
<tr class="separator:gafd0cd7bf47eba289f9a04873c0d60a16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga40901598735b221da45e0e701e3b10f4"><td class="memItemLeft" align="right" valign="top">
|
|
typedef struct <a class="el" href="structsn__nsdl__addr__.html">sn_nsdl_addr_</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga40901598735b221da45e0e701e3b10f4">sn_nsdl_addr_s</a></td></tr>
|
|
<tr class="memdesc:ga40901598735b221da45e0e701e3b10f4"><td class="mdescLeft"> </td><td class="mdescRight">Address structure of Packet data. <br /></td></tr>
|
|
<tr class="separator:ga40901598735b221da45e0e701e3b10f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gac948c83575959f22cd87b02c247ae9f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac948c83575959f22cd87b02c247ae9f5"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gac948c83575959f22cd87b02c247ae9f5">coap_version_</a> { <b>COAP_VERSION_1</b> = 0x40,
|
|
<b>COAP_VERSION_UNKNOWN</b> = 0xFF
|
|
}<tr class="memdesc:gac948c83575959f22cd87b02c247ae9f5"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Version. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gac948c83575959f22cd87b02c247ae9f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae1614153357c1121ce822a00b2c2293d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gae1614153357c1121ce822a00b2c2293d">sn_coap_msg_type_</a> { <a class="el" href="group__coap.html#ggae1614153357c1121ce822a00b2c2293daeac11476d9e8c20e4b464b07e3f5488d">COAP_MSG_TYPE_CONFIRMABLE</a> = 0x00,
|
|
<a class="el" href="group__coap.html#ggae1614153357c1121ce822a00b2c2293da7dc226ba80ea7fa95d6ff7c7e4b43b39">COAP_MSG_TYPE_NON_CONFIRMABLE</a> = 0x10,
|
|
<a class="el" href="group__coap.html#ggae1614153357c1121ce822a00b2c2293dacb9e26e6eeb031a1fa745bd54173bc0f">COAP_MSG_TYPE_ACKNOWLEDGEMENT</a> = 0x20,
|
|
<a class="el" href="group__coap.html#ggae1614153357c1121ce822a00b2c2293dae1019d0ea20993a74849ccd608c830ea">COAP_MSG_TYPE_RESET</a> = 0x30
|
|
}<tr class="memdesc:gae1614153357c1121ce822a00b2c2293d"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Message type, used in CoAP Header. <a href="group__coap.html#gae1614153357c1121ce822a00b2c2293d">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gae1614153357c1121ce822a00b2c2293d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafbdc8dd70f66bbece00badf805d1434d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafbdc8dd70f66bbece00badf805d1434d"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gafbdc8dd70f66bbece00badf805d1434d">sn_coap_msg_code_</a> { <br />
|
|
  <b>COAP_MSG_CODE_EMPTY</b> = 0,
|
|
<b>COAP_MSG_CODE_REQUEST_GET</b> = 1,
|
|
<b>COAP_MSG_CODE_REQUEST_POST</b> = 2,
|
|
<b>COAP_MSG_CODE_REQUEST_PUT</b> = 3,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_REQUEST_DELETE</b> = 4,
|
|
<b>COAP_MSG_CODE_RESPONSE_CREATED</b> = 65,
|
|
<b>COAP_MSG_CODE_RESPONSE_DELETED</b> = 66,
|
|
<b>COAP_MSG_CODE_RESPONSE_VALID</b> = 67,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_RESPONSE_CHANGED</b> = 68,
|
|
<b>COAP_MSG_CODE_RESPONSE_CONTENT</b> = 69,
|
|
<b>COAP_MSG_CODE_RESPONSE_CONTINUE</b> = 95,
|
|
<b>COAP_MSG_CODE_RESPONSE_BAD_REQUEST</b> = 128,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_RESPONSE_UNAUTHORIZED</b> = 129,
|
|
<b>COAP_MSG_CODE_RESPONSE_BAD_OPTION</b> = 130,
|
|
<b>COAP_MSG_CODE_RESPONSE_FORBIDDEN</b> = 131,
|
|
<b>COAP_MSG_CODE_RESPONSE_NOT_FOUND</b> = 132,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_RESPONSE_METHOD_NOT_ALLOWED</b> = 133,
|
|
<b>COAP_MSG_CODE_RESPONSE_NOT_ACCEPTABLE</b> = 134,
|
|
<b>COAP_MSG_CODE_RESPONSE_REQUEST_ENTITY_INCOMPLETE</b> = 136,
|
|
<b>COAP_MSG_CODE_RESPONSE_PRECONDITION_FAILED</b> = 140,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_RESPONSE_REQUEST_ENTITY_TOO_LARGE</b> = 141,
|
|
<b>COAP_MSG_CODE_RESPONSE_UNSUPPORTED_CONTENT_FORMAT</b> = 143,
|
|
<b>COAP_MSG_CODE_RESPONSE_INTERNAL_SERVER_ERROR</b> = 160,
|
|
<b>COAP_MSG_CODE_RESPONSE_NOT_IMPLEMENTED</b> = 161,
|
|
<br />
|
|
  <b>COAP_MSG_CODE_RESPONSE_BAD_GATEWAY</b> = 162,
|
|
<b>COAP_MSG_CODE_RESPONSE_SERVICE_UNAVAILABLE</b> = 163,
|
|
<b>COAP_MSG_CODE_RESPONSE_GATEWAY_TIMEOUT</b> = 164,
|
|
<b>COAP_MSG_CODE_RESPONSE_PROXYING_NOT_SUPPORTED</b> = 165
|
|
<br />
|
|
}<tr class="memdesc:gafbdc8dd70f66bbece00badf805d1434d"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Message code, used in CoAP Header. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gafbdc8dd70f66bbece00badf805d1434d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7e1857c6ffb73e3ef14968ad0d95a2a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7e1857c6ffb73e3ef14968ad0d95a2a5"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga7e1857c6ffb73e3ef14968ad0d95a2a5">sn_coap_option_numbers_</a> { <br />
|
|
  <b>COAP_OPTION_IF_MATCH</b> = 1,
|
|
<b>COAP_OPTION_URI_HOST</b> = 3,
|
|
<b>COAP_OPTION_ETAG</b> = 4,
|
|
<b>COAP_OPTION_IF_NONE_MATCH</b> = 5,
|
|
<br />
|
|
  <b>COAP_OPTION_OBSERVE</b> = 6,
|
|
<b>COAP_OPTION_URI_PORT</b> = 7,
|
|
<b>COAP_OPTION_LOCATION_PATH</b> = 8,
|
|
<b>COAP_OPTION_URI_PATH</b> = 11,
|
|
<br />
|
|
  <b>COAP_OPTION_CONTENT_FORMAT</b> = 12,
|
|
<b>COAP_OPTION_MAX_AGE</b> = 14,
|
|
<b>COAP_OPTION_URI_QUERY</b> = 15,
|
|
<b>COAP_OPTION_ACCEPT</b> = 17,
|
|
<br />
|
|
  <b>COAP_OPTION_LOCATION_QUERY</b> = 20,
|
|
<b>COAP_OPTION_BLOCK2</b> = 23,
|
|
<b>COAP_OPTION_BLOCK1</b> = 27,
|
|
<b>COAP_OPTION_SIZE2</b> = 28,
|
|
<br />
|
|
  <b>COAP_OPTION_PROXY_URI</b> = 35,
|
|
<b>COAP_OPTION_PROXY_SCHEME</b> = 39,
|
|
<b>COAP_OPTION_SIZE1</b> = 60
|
|
<br />
|
|
}<tr class="memdesc:ga7e1857c6ffb73e3ef14968ad0d95a2a5"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Option number, used in CoAP Header. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga7e1857c6ffb73e3ef14968ad0d95a2a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga59684aa6c35b020f309d037d4b2e30a1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga59684aa6c35b020f309d037d4b2e30a1"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga59684aa6c35b020f309d037d4b2e30a1">sn_coap_content_format_</a> { <br />
|
|
  <b>COAP_CT_NONE</b> = -1,
|
|
<b>COAP_CT_TEXT_PLAIN</b> = 0,
|
|
<b>COAP_CT_LINK_FORMAT</b> = 40,
|
|
<b>COAP_CT_XML</b> = 41,
|
|
<br />
|
|
  <b>COAP_CT_OCTET_STREAM</b> = 42,
|
|
<b>COAP_CT_EXI</b> = 47,
|
|
<b>COAP_CT_JSON</b> = 50,
|
|
<b>COAP_CT__MAX</b> = 0xffff
|
|
<br />
|
|
}<tr class="memdesc:ga59684aa6c35b020f309d037d4b2e30a1"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Content Format codes. <br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga59684aa6c35b020f309d037d4b2e30a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4812fa835aae48adb994af470461260d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga4812fa835aae48adb994af470461260d">sn_coap_observe_</a> { <b>COAP_OBSERVE_NONE</b> = -1,
|
|
<b>COAP_OBSERVE_REGISTER</b> = 0,
|
|
<b>COAP_OBSERVE_DEREGISTER</b> = 1,
|
|
<b>COAP_OBSERVE__MAX</b> = 0xffffff
|
|
}<tr class="memdesc:ga4812fa835aae48adb994af470461260d"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP Observe option values. <a href="group__coap.html#ga4812fa835aae48adb994af470461260d">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga4812fa835aae48adb994af470461260d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga694d02e174302d5eb033a144d8bec7b6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga694d02e174302d5eb033a144d8bec7b6">sn_coap_status_</a> { <br />
|
|
  <a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a42c821f9a3d08e879af1e52482adc4b1">COAP_STATUS_OK</a> = 0,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a4765560ab4ce2350cb38c661bfd7124a">COAP_STATUS_PARSER_ERROR_IN_HEADER</a> = 1,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6ab8ffe45bd6654f3e8b1d179fabad741a">COAP_STATUS_PARSER_DUPLICATED_MSG</a> = 2,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a97a28c97810a9cc70701d203478df22b">COAP_STATUS_PARSER_BLOCKWISE_MSG_RECEIVING</a> = 3,
|
|
<br />
|
|
  <a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a5172d027323897d435285ed2ac79a8d8">COAP_STATUS_PARSER_BLOCKWISE_ACK</a> = 4,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a8fdd59079ac4d82ba36a31293f548581">COAP_STATUS_PARSER_BLOCKWISE_MSG_REJECTED</a> = 5,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a3bfe3d484269b3f95ea270458ab918cb">COAP_STATUS_PARSER_BLOCKWISE_MSG_RECEIVED</a> = 6,
|
|
<a class="el" href="group__coap.html#gga694d02e174302d5eb033a144d8bec7b6a8ca88652e2970108cfde34c5870bfbd3">COAP_STATUS_BUILDER_MESSAGE_SENDING_FAILED</a> = 7
|
|
<br />
|
|
}<tr class="memdesc:ga694d02e174302d5eb033a144d8bec7b6"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for CoAP status, used in CoAP Header. <a href="group__coap.html#ga694d02e174302d5eb033a144d8bec7b6">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga694d02e174302d5eb033a144d8bec7b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0969492dc63242b2aa3946d0a79f756b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga0969492dc63242b2aa3946d0a79f756b">sn_nsdl_capab_</a> { <a class="el" href="group__coap.html#gga0969492dc63242b2aa3946d0a79f756ba5fda451925f1db03222285d3fdcd364f">SN_NSDL_PROTOCOL_HTTP</a> = 0x01,
|
|
<a class="el" href="group__coap.html#gga0969492dc63242b2aa3946d0a79f756bad3393066833411ae0ad92f085814c72d">SN_NSDL_PROTOCOL_HTTPS</a> = 0x02,
|
|
<a class="el" href="group__coap.html#gga0969492dc63242b2aa3946d0a79f756ba50104d8371f55ab2e51acb8f2974e4a6">SN_NSDL_PROTOCOL_COAP</a> = 0x04
|
|
}<tr class="memdesc:ga0969492dc63242b2aa3946d0a79f756b"><td class="mdescLeft"> </td><td class="mdescRight">Used protocol. <a href="group__coap.html#ga0969492dc63242b2aa3946d0a79f756b">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga0969492dc63242b2aa3946d0a79f756b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa79e2f954a9a6b14f564e1f428f618fe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gaa79e2f954a9a6b14f564e1f428f618fe">sn_nsdl_addr_type_</a> { <a class="el" href="group__coap.html#ggaa79e2f954a9a6b14f564e1f428f618feaf11a6d113c6e9572019bce1da78dc48d">SN_NSDL_ADDRESS_TYPE_IPV6</a> = 0x01,
|
|
<a class="el" href="group__coap.html#ggaa79e2f954a9a6b14f564e1f428f618feaf2fd536d9027140a1338225d4d6a113f">SN_NSDL_ADDRESS_TYPE_IPV4</a> = 0x02,
|
|
<a class="el" href="group__coap.html#ggaa79e2f954a9a6b14f564e1f428f618feac66a97d86630742f8a0f8aae4de6e3fa">SN_NSDL_ADDRESS_TYPE_HOSTNAME</a> = 0x03,
|
|
<b>SN_NSDL_ADDRESS_TYPE_NONE</b> = 0xFF
|
|
}<tr class="memdesc:gaa79e2f954a9a6b14f564e1f428f618fe"><td class="mdescLeft"> </td><td class="mdescRight">Address type of given address. <a href="group__coap.html#gaa79e2f954a9a6b14f564e1f428f618fe">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaa79e2f954a9a6b14f564e1f428f618fe"><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:ga80104792c9673afa8412879e0cb2d9cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga80104792c9673afa8412879e0cb2d9cc">sn_coap_parser</a> (struct coap_s *handle, uint16_t packet_data_len, uint8_t *packet_data_ptr, <a class="el" href="group__coap.html#gaf9efd1fa3a3c58bcddcd8e5f5a09b032">coap_version_e</a> *coap_version_ptr)</td></tr>
|
|
<tr class="memdesc:ga80104792c9673afa8412879e0cb2d9cc"><td class="mdescLeft"> </td><td class="mdescRight">Parses CoAP message from given Packet data. <a href="group__coap.html#ga80104792c9673afa8412879e0cb2d9cc">More...</a><br /></td></tr>
|
|
<tr class="separator:ga80104792c9673afa8412879e0cb2d9cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga69067137006ea18c05114816e4ab8723"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga69067137006ea18c05114816e4ab8723">sn_coap_parser_release_allocated_coap_msg_mem</a> (struct coap_s *handle, <a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *freed_coap_msg_ptr)</td></tr>
|
|
<tr class="memdesc:ga69067137006ea18c05114816e4ab8723"><td class="mdescLeft"> </td><td class="mdescRight">Releases memory of given CoAP message. <a href="group__coap.html#ga69067137006ea18c05114816e4ab8723">More...</a><br /></td></tr>
|
|
<tr class="separator:ga69067137006ea18c05114816e4ab8723"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1154e1630130b2b4cfffd3a10259d2a8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga1154e1630130b2b4cfffd3a10259d2a8">sn_coap_builder</a> (uint8_t *dst_packet_data_ptr, <a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *src_coap_msg_ptr)</td></tr>
|
|
<tr class="memdesc:ga1154e1630130b2b4cfffd3a10259d2a8"><td class="mdescLeft"> </td><td class="mdescRight">Builds an outgoing message buffer from a CoAP header structure. <a href="group__coap.html#ga1154e1630130b2b4cfffd3a10259d2a8">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1154e1630130b2b4cfffd3a10259d2a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaac235555ebad7eb13949aa18d5e783f"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gaaac235555ebad7eb13949aa18d5e783f">sn_coap_builder_calc_needed_packet_data_size</a> (<a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *src_coap_msg_ptr)</td></tr>
|
|
<tr class="memdesc:gaaac235555ebad7eb13949aa18d5e783f"><td class="mdescLeft"> </td><td class="mdescRight">Calculates needed Packet data memory size for given CoAP message. <a href="group__coap.html#gaaac235555ebad7eb13949aa18d5e783f">More...</a><br /></td></tr>
|
|
<tr class="separator:gaaac235555ebad7eb13949aa18d5e783f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga174db4c5a65f5a12f28855a2d62fe41d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga174db4c5a65f5a12f28855a2d62fe41d">sn_coap_builder_2</a> (uint8_t *dst_packet_data_ptr, <a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *src_coap_msg_ptr, uint16_t blockwise_payload_size)</td></tr>
|
|
<tr class="memdesc:ga174db4c5a65f5a12f28855a2d62fe41d"><td class="mdescLeft"> </td><td class="mdescRight">Builds an outgoing message buffer from a CoAP header structure. <a href="group__coap.html#ga174db4c5a65f5a12f28855a2d62fe41d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga174db4c5a65f5a12f28855a2d62fe41d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad5d0769a114c570b1a4d8c97e9173415"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gad5d0769a114c570b1a4d8c97e9173415">sn_coap_builder_calc_needed_packet_data_size_2</a> (<a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *src_coap_msg_ptr, uint16_t blockwise_payload_size)</td></tr>
|
|
<tr class="memdesc:gad5d0769a114c570b1a4d8c97e9173415"><td class="mdescLeft"> </td><td class="mdescRight">Calculates needed Packet data memory size for given CoAP message. <a href="group__coap.html#gad5d0769a114c570b1a4d8c97e9173415">More...</a><br /></td></tr>
|
|
<tr class="separator:gad5d0769a114c570b1a4d8c97e9173415"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga60064d3b286da3b3aba41848934ad8f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga60064d3b286da3b3aba41848934ad8f6">sn_coap_build_response</a> (struct coap_s *handle, <a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *coap_packet_ptr, uint8_t msg_code)</td></tr>
|
|
<tr class="memdesc:ga60064d3b286da3b3aba41848934ad8f6"><td class="mdescLeft"> </td><td class="mdescRight">Prepares generic response packet from a request packet. This function allocates memory for the resulting sn_coap_hdr_s. <a href="group__coap.html#ga60064d3b286da3b3aba41848934ad8f6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga60064d3b286da3b3aba41848934ad8f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab9ac3f8363bb8fb97f812c715b41ba88"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#gab9ac3f8363bb8fb97f812c715b41ba88">sn_coap_parser_init_message</a> (<a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *coap_msg_ptr)</td></tr>
|
|
<tr class="memdesc:gab9ac3f8363bb8fb97f812c715b41ba88"><td class="mdescLeft"> </td><td class="mdescRight">Initialise a message structure to empty. <a href="group__coap.html#gab9ac3f8363bb8fb97f812c715b41ba88">More...</a><br /></td></tr>
|
|
<tr class="separator:gab9ac3f8363bb8fb97f812c715b41ba88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga390079da13bcb662d7cc70c77b0070ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga390079da13bcb662d7cc70c77b0070ec">sn_coap_parser_alloc_message</a> (struct coap_s *handle)</td></tr>
|
|
<tr class="memdesc:ga390079da13bcb662d7cc70c77b0070ec"><td class="mdescLeft"> </td><td class="mdescRight">Allocate an empty message structure. <a href="group__coap.html#ga390079da13bcb662d7cc70c77b0070ec">More...</a><br /></td></tr>
|
|
<tr class="separator:ga390079da13bcb662d7cc70c77b0070ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga864cefe478283076dd8c09a452c0894f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__coap.html#ga53d117b7c5da476f085e72ff4dfa1e39">sn_coap_options_list_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coap.html#ga864cefe478283076dd8c09a452c0894f">sn_coap_parser_alloc_options</a> (struct coap_s *handle, <a class="el" href="group__coap.html#ga3a52e89139fbb21b93186618be191a04">sn_coap_hdr_s</a> *coap_msg_ptr)</td></tr>
|
|
<tr class="memdesc:ga864cefe478283076dd8c09a452c0894f"><td class="mdescLeft"> </td><td class="mdescRight">Allocates and initializes options list structure. <a href="group__coap.html#ga864cefe478283076dd8c09a452c0894f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga864cefe478283076dd8c09a452c0894f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>CoAP C-library User header interface header file. </p>
|
|
</div></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|