mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 04:30:46 +01:00
811 lines
47 KiB
HTML
811 lines
47 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=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>esp-nimble-cpp: NimBLEAttValue Class 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>
|
|
<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">esp-nimble-cpp
|
|
 <span id="projectnumber">1.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_nim_b_l_e_att_value.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-methods">Public Member Functions</a> |
|
|
<a href="class_nim_b_l_e_att_value-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NimBLEAttValue Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A specialized container class to hold BLE attribute values.
|
|
<a href="class_nim_b_l_e_att_value.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa801ed93f65e8cbc507c6ea6f4f49294"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa801ed93f65e8cbc507c6ea6f4f49294">NimBLEAttValue</a> (uint16_t init_len=<a class="el" href="nimconfig_8h.html#a4d4ea715325f75455b43c7dbaa69d7a0">CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH</a>, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:aa801ed93f65e8cbc507c6ea6f4f49294"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_nim_b_l_e_att_value.html#aa801ed93f65e8cbc507c6ea6f4f49294">More...</a><br /></td></tr>
|
|
<tr class="separator:aa801ed93f65e8cbc507c6ea6f4f49294"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0bbdf17e7861cbb4bb2cadae9cbe32c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#ad0bbdf17e7861cbb4bb2cadae9cbe32c">NimBLEAttValue</a> (const uint8_t *value, uint16_t len, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:ad0bbdf17e7861cbb4bb2cadae9cbe32c"><td class="mdescLeft"> </td><td class="mdescRight">Construct with an initial value from a buffer. <a href="class_nim_b_l_e_att_value.html#ad0bbdf17e7861cbb4bb2cadae9cbe32c">More...</a><br /></td></tr>
|
|
<tr class="separator:ad0bbdf17e7861cbb4bb2cadae9cbe32c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61813a898f1bfb1b00e670a7fbb413df"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a61813a898f1bfb1b00e670a7fbb413df">NimBLEAttValue</a> (std::initializer_list< uint8_t > list, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:a61813a898f1bfb1b00e670a7fbb413df"><td class="mdescLeft"> </td><td class="mdescRight">Construct with an initializer list. <a href="class_nim_b_l_e_att_value.html#a61813a898f1bfb1b00e670a7fbb413df">More...</a><br /></td></tr>
|
|
<tr class="separator:a61813a898f1bfb1b00e670a7fbb413df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4322572d778438318f5750f6df5fdb35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a4322572d778438318f5750f6df5fdb35">NimBLEAttValue</a> (const char *value, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:a4322572d778438318f5750f6df5fdb35"><td class="mdescLeft"> </td><td class="mdescRight">Construct with an initial value from a const char string. <a href="class_nim_b_l_e_att_value.html#a4322572d778438318f5750f6df5fdb35">More...</a><br /></td></tr>
|
|
<tr class="separator:a4322572d778438318f5750f6df5fdb35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a584cac329cd5d3c0a14aa855e6e6143e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a584cac329cd5d3c0a14aa855e6e6143e">NimBLEAttValue</a> (const std::string str, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:a584cac329cd5d3c0a14aa855e6e6143e"><td class="mdescLeft"> </td><td class="mdescRight">Construct with an initial value from a std::string. <a href="class_nim_b_l_e_att_value.html#a584cac329cd5d3c0a14aa855e6e6143e">More...</a><br /></td></tr>
|
|
<tr class="separator:a584cac329cd5d3c0a14aa855e6e6143e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03347eab1f3df449762902a4256d2b1c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a03347eab1f3df449762902a4256d2b1c">NimBLEAttValue</a> (const std::vector< uint8_t > vec, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</td></tr>
|
|
<tr class="memdesc:a03347eab1f3df449762902a4256d2b1c"><td class="mdescLeft"> </td><td class="mdescRight">Construct with an initial value from a std::vector<uint8_t>. <a href="class_nim_b_l_e_att_value.html#a03347eab1f3df449762902a4256d2b1c">More...</a><br /></td></tr>
|
|
<tr class="separator:a03347eab1f3df449762902a4256d2b1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7473ad95c2240e0d1ce5c2d57f8914c2"><td class="memItemLeft" align="right" valign="top"><a id="a7473ad95c2240e0d1ce5c2d57f8914c2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a7473ad95c2240e0d1ce5c2d57f8914c2">NimBLEAttValue</a> (const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &source)</td></tr>
|
|
<tr class="memdesc:a7473ad95c2240e0d1ce5c2d57f8914c2"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
|
|
<tr class="separator:a7473ad95c2240e0d1ce5c2d57f8914c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a778d1da5334049292fdfba221bcd5772"><td class="memItemLeft" align="right" valign="top"><a id="a778d1da5334049292fdfba221bcd5772"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a778d1da5334049292fdfba221bcd5772">NimBLEAttValue</a> (<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &&source)</td></tr>
|
|
<tr class="memdesc:a778d1da5334049292fdfba221bcd5772"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a778d1da5334049292fdfba221bcd5772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08f3b04d05cf0c2b76a24cc37cd1f8ab"><td class="memItemLeft" align="right" valign="top"><a id="a08f3b04d05cf0c2b76a24cc37cd1f8ab"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a08f3b04d05cf0c2b76a24cc37cd1f8ab">~NimBLEAttValue</a> ()</td></tr>
|
|
<tr class="memdesc:a08f3b04d05cf0c2b76a24cc37cd1f8ab"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a08f3b04d05cf0c2b76a24cc37cd1f8ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7abc6cd08adb0b654e051d62af725d5"><td class="memItemLeft" align="right" valign="top"><a id="ac7abc6cd08adb0b654e051d62af725d5"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#ac7abc6cd08adb0b654e051d62af725d5">max_size</a> () const</td></tr>
|
|
<tr class="memdesc:ac7abc6cd08adb0b654e051d62af725d5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the max size in bytes. <br /></td></tr>
|
|
<tr class="separator:ac7abc6cd08adb0b654e051d62af725d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49a8a126d0b534c999c4a341cdcf7ba2"><td class="memItemLeft" align="right" valign="top"><a id="a49a8a126d0b534c999c4a341cdcf7ba2"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a49a8a126d0b534c999c4a341cdcf7ba2">capacity</a> () const</td></tr>
|
|
<tr class="memdesc:a49a8a126d0b534c999c4a341cdcf7ba2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently allocated capacity in bytes. <br /></td></tr>
|
|
<tr class="separator:a49a8a126d0b534c999c4a341cdcf7ba2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35df29c514613b1d00841abd6fffa320"><td class="memItemLeft" align="right" valign="top"><a id="a35df29c514613b1d00841abd6fffa320"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a35df29c514613b1d00841abd6fffa320">length</a> () const</td></tr>
|
|
<tr class="memdesc:a35df29c514613b1d00841abd6fffa320"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current length of the value in bytes. <br /></td></tr>
|
|
<tr class="separator:a35df29c514613b1d00841abd6fffa320"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8c75101d9898c3ff4646d84521ed61c"><td class="memItemLeft" align="right" valign="top"><a id="aa8c75101d9898c3ff4646d84521ed61c"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa8c75101d9898c3ff4646d84521ed61c">size</a> () const</td></tr>
|
|
<tr class="memdesc:aa8c75101d9898c3ff4646d84521ed61c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current size of the value in bytes. <br /></td></tr>
|
|
<tr class="separator:aa8c75101d9898c3ff4646d84521ed61c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e595630f7959b4002f6fb64c69ae123"><td class="memItemLeft" align="right" valign="top"><a id="a9e595630f7959b4002f6fb64c69ae123"></a>
|
|
const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a9e595630f7959b4002f6fb64c69ae123">data</a> () const</td></tr>
|
|
<tr class="memdesc:a9e595630f7959b4002f6fb64c69ae123"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the internal buffer of the value. <br /></td></tr>
|
|
<tr class="separator:a9e595630f7959b4002f6fb64c69ae123"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2c18949ffc2e7d2d2f288c1b2b2f0ed"><td class="memItemLeft" align="right" valign="top"><a id="aa2c18949ffc2e7d2d2f288c1b2b2f0ed"></a>
|
|
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa2c18949ffc2e7d2d2f288c1b2b2f0ed">c_str</a> () const</td></tr>
|
|
<tr class="memdesc:aa2c18949ffc2e7d2d2f288c1b2b2f0ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the internal buffer of the value as a const char*. <br /></td></tr>
|
|
<tr class="separator:aa2c18949ffc2e7d2d2f288c1b2b2f0ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6167f1cbc50a81a4ca0708e273bbb63e"><td class="memItemLeft" align="right" valign="top"><a id="a6167f1cbc50a81a4ca0708e273bbb63e"></a>
|
|
const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a6167f1cbc50a81a4ca0708e273bbb63e">begin</a> () const</td></tr>
|
|
<tr class="memdesc:a6167f1cbc50a81a4ca0708e273bbb63e"><td class="mdescLeft"> </td><td class="mdescRight">Iterator begin. <br /></td></tr>
|
|
<tr class="separator:a6167f1cbc50a81a4ca0708e273bbb63e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f797f89e9c2d55dc7bee7ec8993952e"><td class="memItemLeft" align="right" valign="top"><a id="a4f797f89e9c2d55dc7bee7ec8993952e"></a>
|
|
const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a4f797f89e9c2d55dc7bee7ec8993952e">end</a> () const</td></tr>
|
|
<tr class="memdesc:a4f797f89e9c2d55dc7bee7ec8993952e"><td class="mdescLeft"> </td><td class="mdescRight">Iterator end. <br /></td></tr>
|
|
<tr class="separator:a4f797f89e9c2d55dc7bee7ec8993952e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c8c5ecfa3864d45ea5b155385e3f9fa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a5c8c5ecfa3864d45ea5b155385e3f9fa">setValue</a> (const uint8_t *value, uint16_t len)</td></tr>
|
|
<tr class="memdesc:a5c8c5ecfa3864d45ea5b155385e3f9fa"><td class="mdescLeft"> </td><td class="mdescRight">Set the value from a buffer. <a href="class_nim_b_l_e_att_value.html#a5c8c5ecfa3864d45ea5b155385e3f9fa">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c8c5ecfa3864d45ea5b155385e3f9fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c0f67d150d198c5bcad6eafafee21b6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a9c0f67d150d198c5bcad6eafafee21b6">setValue</a> (const char *s)</td></tr>
|
|
<tr class="memdesc:a9c0f67d150d198c5bcad6eafafee21b6"><td class="mdescLeft"> </td><td class="mdescRight">Set value to the value of const char*. <a href="class_nim_b_l_e_att_value.html#a9c0f67d150d198c5bcad6eafafee21b6">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c0f67d150d198c5bcad6eafafee21b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60fb3dc7057d4ec800c3ef6fd2480a69"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a60fb3dc7057d4ec800c3ef6fd2480a69">getValue</a> (time_t *timestamp)</td></tr>
|
|
<tr class="memdesc:a60fb3dc7057d4ec800c3ef6fd2480a69"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the value buffer with timestamp. <a href="class_nim_b_l_e_att_value.html#a60fb3dc7057d4ec800c3ef6fd2480a69">More...</a><br /></td></tr>
|
|
<tr class="separator:a60fb3dc7057d4ec800c3ef6fd2480a69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa217dfc649daed50eb75c7168442f86e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa217dfc649daed50eb75c7168442f86e">append</a> (const uint8_t *value, uint16_t len)</td></tr>
|
|
<tr class="memdesc:aa217dfc649daed50eb75c7168442f86e"><td class="mdescLeft"> </td><td class="mdescRight">Append data to the value. <a href="class_nim_b_l_e_att_value.html#aa217dfc649daed50eb75c7168442f86e">More...</a><br /></td></tr>
|
|
<tr class="separator:aa217dfc649daed50eb75c7168442f86e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#ac94a41f0c0d42d48b29d5b18d7ad7bd8">setValue</a> (const T &s)</td></tr>
|
|
<tr class="memdesc:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="mdescLeft"> </td><td class="mdescRight">Template to set value to the value of <type>val. <a href="class_nim_b_l_e_att_value.html#ac94a41f0c0d42d48b29d5b18d7ad7bd8">More...</a><br /></td></tr>
|
|
<tr class="separator:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#ac94a41f0c0d42d48b29d5b18d7ad7bd8">setValue</a> (const T &s)</td></tr>
|
|
<tr class="memdesc:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="mdescLeft"> </td><td class="mdescRight">Template to set value to the value of <type>val. <a href="class_nim_b_l_e_att_value.html#ac94a41f0c0d42d48b29d5b18d7ad7bd8">More...</a><br /></td></tr>
|
|
<tr class="separator:ac94a41f0c0d42d48b29d5b18d7ad7bd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1aca76279ea3f0d8cb06ff5540a326e3"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a1aca76279ea3f0d8cb06ff5540a326e3"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a1aca76279ea3f0d8cb06ff5540a326e3">getValue</a> (time_t *timestamp=nullptr, bool skipSizeCheck=false)</td></tr>
|
|
<tr class="memdesc:a1aca76279ea3f0d8cb06ff5540a326e3"><td class="mdescLeft"> </td><td class="mdescRight">Template to return the value as a <type>. <a href="class_nim_b_l_e_att_value.html#a1aca76279ea3f0d8cb06ff5540a326e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a1aca76279ea3f0d8cb06ff5540a326e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ca8d07c06a79e30bf6279e6817e4881"><td class="memItemLeft" align="right" valign="top"><a id="a8ca8d07c06a79e30bf6279e6817e4881"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a8ca8d07c06a79e30bf6279e6817e4881">operator[]</a> (int pos) const</td></tr>
|
|
<tr class="memdesc:a8ca8d07c06a79e30bf6279e6817e4881"><td class="mdescLeft"> </td><td class="mdescRight">Subscript operator. <br /></td></tr>
|
|
<tr class="separator:a8ca8d07c06a79e30bf6279e6817e4881"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3af3b6efb528b1063df2de409c64a0d6"><td class="memItemLeft" align="right" valign="top"><a id="a3af3b6efb528b1063df2de409c64a0d6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a3af3b6efb528b1063df2de409c64a0d6">operator std::vector< uint8_t ></a> () const</td></tr>
|
|
<tr class="memdesc:a3af3b6efb528b1063df2de409c64a0d6"><td class="mdescLeft"> </td><td class="mdescRight">Operator; Get the value as a std::vector<uint8_t>. <br /></td></tr>
|
|
<tr class="separator:a3af3b6efb528b1063df2de409c64a0d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5edd484c83c5efa62916add8927a6371"><td class="memItemLeft" align="right" valign="top"><a id="a5edd484c83c5efa62916add8927a6371"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a5edd484c83c5efa62916add8927a6371">operator std::string</a> () const</td></tr>
|
|
<tr class="memdesc:a5edd484c83c5efa62916add8927a6371"><td class="mdescLeft"> </td><td class="mdescRight">Operator; Get the value as a std::string. <br /></td></tr>
|
|
<tr class="separator:a5edd484c83c5efa62916add8927a6371"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3aa926c56cd58146a5b1c6e02c97894b"><td class="memItemLeft" align="right" valign="top"><a id="a3aa926c56cd58146a5b1c6e02c97894b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a3aa926c56cd58146a5b1c6e02c97894b">operator const uint8_t *</a> () const</td></tr>
|
|
<tr class="memdesc:a3aa926c56cd58146a5b1c6e02c97894b"><td class="mdescLeft"> </td><td class="mdescRight">Operator; Get the value as a const uint8_t*. <br /></td></tr>
|
|
<tr class="separator:a3aa926c56cd58146a5b1c6e02c97894b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e6691f9660a2b78e038e87e99914696"><td class="memItemLeft" align="right" valign="top"><a id="a0e6691f9660a2b78e038e87e99914696"></a>
|
|
<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a0e6691f9660a2b78e038e87e99914696">operator+=</a> (const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &source)</td></tr>
|
|
<tr class="memdesc:a0e6691f9660a2b78e038e87e99914696"><td class="mdescLeft"> </td><td class="mdescRight">Operator; Append another <a class="el" href="class_nim_b_l_e_att_value.html" title="A specialized container class to hold BLE attribute values.">NimBLEAttValue</a>. <br /></td></tr>
|
|
<tr class="separator:a0e6691f9660a2b78e038e87e99914696"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0545edd766dc4ca6e3ebfac5efa384e"><td class="memItemLeft" align="right" valign="top"><a id="aa0545edd766dc4ca6e3ebfac5efa384e"></a>
|
|
<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa0545edd766dc4ca6e3ebfac5efa384e">operator=</a> (const std::string &source)</td></tr>
|
|
<tr class="memdesc:aa0545edd766dc4ca6e3ebfac5efa384e"><td class="mdescLeft"> </td><td class="mdescRight">Operator; Set the value from a std::string source. <br /></td></tr>
|
|
<tr class="separator:aa0545edd766dc4ca6e3ebfac5efa384e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47d30a61ba65f5d9a21fa593cf15d4b9"><td class="memItemLeft" align="right" valign="top"><a id="a47d30a61ba65f5d9a21fa593cf15d4b9"></a>
|
|
<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a47d30a61ba65f5d9a21fa593cf15d4b9">operator=</a> (<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &&source)</td></tr>
|
|
<tr class="memdesc:a47d30a61ba65f5d9a21fa593cf15d4b9"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:a47d30a61ba65f5d9a21fa593cf15d4b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa53ee00be956c25596cf7cce71b502ba"><td class="memItemLeft" align="right" valign="top"><a id="aa53ee00be956c25596cf7cce71b502ba"></a>
|
|
<a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#aa53ee00be956c25596cf7cce71b502ba">operator=</a> (const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &source)</td></tr>
|
|
<tr class="memdesc:aa53ee00be956c25596cf7cce71b502ba"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator. <br /></td></tr>
|
|
<tr class="separator:aa53ee00be956c25596cf7cce71b502ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9634dd47ea705ec8d10f29482e572bbf"><td class="memItemLeft" align="right" valign="top"><a id="a9634dd47ea705ec8d10f29482e572bbf"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a9634dd47ea705ec8d10f29482e572bbf">operator==</a> (const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &source)</td></tr>
|
|
<tr class="memdesc:a9634dd47ea705ec8d10f29482e572bbf"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <br /></td></tr>
|
|
<tr class="separator:a9634dd47ea705ec8d10f29482e572bbf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9dc3bc75c3a0cedf76bed59ef2d0d289"><td class="memItemLeft" align="right" valign="top"><a id="a9dc3bc75c3a0cedf76bed59ef2d0d289"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_att_value.html#a9dc3bc75c3a0cedf76bed59ef2d0d289">operator!=</a> (const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &source)</td></tr>
|
|
<tr class="memdesc:a9dc3bc75c3a0cedf76bed59ef2d0d289"><td class="mdescLeft"> </td><td class="mdescRight">Inequality operator. <br /></td></tr>
|
|
<tr class="separator:a9dc3bc75c3a0cedf76bed59ef2d0d289"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A specialized container class to hold BLE attribute values. </p>
|
|
<p>This class is designed to be more memory efficient than using<br />
|
|
standard container types for value storage, while being convertible to<br />
|
|
many different container classes. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aa801ed93f65e8cbc507c6ea6f4f49294"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa801ed93f65e8cbc507c6ea6f4f49294">◆ </a></span>NimBLEAttValue() <span class="overload">[1/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>init_len</em> = <code><a class="el" href="nimconfig_8h.html#a4d4ea715325f75455b43c7dbaa69d7a0">CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH</a></code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">init_len</td><td>The initial size in bytes. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0bbdf17e7861cbb4bb2cadae9cbe32c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0bbdf17e7861cbb4bb2cadae9cbe32c">◆ </a></span>NimBLEAttValue() <span class="overload">[2/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with an initial value from a buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">value</td><td>A pointer to the initial value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The size in bytes of the value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61813a898f1bfb1b00e670a7fbb413df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61813a898f1bfb1b00e670a7fbb413df">◆ </a></span>NimBLEAttValue() <span class="overload">[3/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::initializer_list< uint8_t > </td>
|
|
<td class="paramname"><em>list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with an initializer list. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">list</td><td>An initializer list containing the initial value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4322572d778438318f5750f6df5fdb35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4322572d778438318f5750f6df5fdb35">◆ </a></span>NimBLEAttValue() <span class="overload">[4/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with an initial value from a const char string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">value</td><td>A pointer to the initial value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a584cac329cd5d3c0a14aa855e6e6143e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a584cac329cd5d3c0a14aa855e6e6143e">◆ </a></span>NimBLEAttValue() <span class="overload">[5/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with an initial value from a std::string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">str</td><td>A std::string containing to the initial value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03347eab1f3df449762902a4256d2b1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03347eab1f3df449762902a4256d2b1c">◆ </a></span>NimBLEAttValue() <span class="overload">[6/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NimBLEAttValue::NimBLEAttValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< uint8_t > </td>
|
|
<td class="paramname"><em>vec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>max_len</em> = <code>BLE_ATT_ATTR_MAX_LEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct with an initial value from a std::vector<uint8_t>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vec</td><td>A std::vector<uint8_t> containing to the initial value to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The max size in bytes that the value can be. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa217dfc649daed50eb75c7168442f86e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa217dfc649daed50eb75c7168442f86e">◆ </a></span>append()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> & NimBLEAttValue::append </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Append data to the value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A ponter to a data buffer with the value to append. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length of the value to append in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the appended <a class="el" href="class_nim_b_l_e_att_value.html" title="A specialized container class to hold BLE attribute values.">NimBLEAttValue</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60fb3dc7057d4ec800c3ef6fd2480a69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60fb3dc7057d4ec800c3ef6fd2480a69">◆ </a></span>getValue() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint8_t * NimBLEAttValue::getValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">time_t * </td>
|
|
<td class="paramname"><em>timestamp</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a pointer to the value buffer with timestamp. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timestamp</td><td>A ponter to a time_t variable to store the timestamp. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the internal value buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1aca76279ea3f0d8cb06ff5540a326e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1aca76279ea3f0d8cb06ff5540a326e3">◆ </a></span>getValue() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T NimBLEAttValue::getValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">time_t * </td>
|
|
<td class="paramname"><em>timestamp</em> = <code>nullptr</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>skipSizeCheck</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Template to return the value as a <type>. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The type to convert the data to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timestamp</td><td>A pointer to a time_t struct to store the time the value was read. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">skipSizeCheck</td><td>If true it will skip checking if the data size is less than<br />
|
|
<code>sizeof(<type>)</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The data converted to <type> or NULL if skipSizeCheck is false and the data is<br />
|
|
less than <code>sizeof(<type>)</code>.</dd></dl>
|
|
<p><b>Use:</b> <code>getValue<type>(&timestamp, skipSizeCheck);</code> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c0f67d150d198c5bcad6eafafee21b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c0f67d150d198c5bcad6eafafee21b6">◆ </a></span>setValue() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAttValue::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set value to the value of const char*. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>A ponter to a const char value to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac94a41f0c0d42d48b29d5b18d7ad7bd8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac94a41f0c0d42d48b29d5b18d7ad7bd8">◆ </a></span>setValue() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAttValue::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Template to set value to the value of <type>val. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The <type>value to set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Only used for types without a <code><a class="el" href="class_nim_b_l_e_att_value.html#aa2c18949ffc2e7d2d2f288c1b2b2f0ed" title="Returns a pointer to the internal buffer of the value as a const char*.">c_str()</a></code> method. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac94a41f0c0d42d48b29d5b18d7ad7bd8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac94a41f0c0d42d48b29d5b18d7ad7bd8">◆ </a></span>setValue() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAttValue::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Template to set value to the value of <type>val. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The <type>value to set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Only used if the <type> has a <code><a class="el" href="class_nim_b_l_e_att_value.html#aa2c18949ffc2e7d2d2f288c1b2b2f0ed" title="Returns a pointer to the internal buffer of the value as a const char*.">c_str()</a></code> method. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c8c5ecfa3864d45ea5b155385e3f9fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c8c5ecfa3864d45ea5b155385e3f9fa">◆ </a></span>setValue() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NimBLEAttValue::setValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the value from a buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A ponter to a buffer containing the value. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length of the value in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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="class_nim_b_l_e_att_value.html">NimBLEAttValue</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|