Diff: doc/html/group__api__core__settings.html

Revision:

29:b6af04b77a56

Parent:

26:8067e3d463d3

--- a/doc/html/group__api__core__settings.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/group__api__core__settings.html	Mon Oct 27 13:42:26 2014 -0700
@@ -124,12 +124,19 @@
 <tr class="memitem:ga670947ef630233f7866f885500548233"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga670947ef630233f7866f885500548233">wiconnect::Wiconnect::getSetting</a> (const char *settingStr, char *valueBuffer, uint16_t valueBufferLen)</td></tr>
 <tr class="memdesc:ga670947ef630233f7866f885500548233"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a module setting.  <a href="#ga670947ef630233f7866f885500548233">More...</a><br /></td></tr>
 <tr class="separator:ga670947ef630233f7866f885500548233"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaaaf8be221699870053ad98911b066a32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaaaf8be221699870053ad98911b066a32">wiconnect::Wiconnect::setCommandDefaultTimeout</a> (int timeoutMs)</td></tr>
-<tr class="memdesc:gaaaf8be221699870053ad98911b066a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the default maximum time an API method may execute before terminating and return a timeout error code.  <a href="#gaaaf8be221699870053ad98911b066a32">More...</a><br /></td></tr>
-<tr class="separator:gaaaf8be221699870053ad98911b066a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gad5d31980a7b1e143f00b0117468c1a7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gad5d31980a7b1e143f00b0117468c1a7e">wiconnect::Wiconnect::getCommandDefaultTimeout</a> ()</td></tr>
-<tr class="memdesc:gad5d31980a7b1e143f00b0117468c1a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current default maximum API execution time.  <a href="#gad5d31980a7b1e143f00b0117468c1a7e">More...</a><br /></td></tr>
-<tr class="separator:gad5d31980a7b1e143f00b0117468c1a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga851795595a422a14249b7ea9f0038c4c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga851795595a422a14249b7ea9f0038c4c">wiconnect::Wiconnect::setBlockingEnabled</a> (bool blockingEnabled)</td></tr>
+<tr class="memdesc:ga851795595a422a14249b7ea9f0038c4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets if API calls are blocking or non-blocking.  <a href="#ga851795595a422a14249b7ea9f0038c4c">More...</a><br /></td></tr>
+<tr class="separator:ga851795595a422a14249b7ea9f0038c4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaf6115968c49c128717cacd2f06b883ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf6115968c49c128717cacd2f06b883ad"></a>
+bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gaf6115968c49c128717cacd2f06b883ad">wiconnect::Wiconnect::getBlockingEnabled</a> (void)</td></tr>
+<tr class="memdesc:gaf6115968c49c128717cacd2f06b883ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets if API calls are blocking or non-blocking. <br /></td></tr>
+<tr class="separator:gaf6115968c49c128717cacd2f06b883ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gacae50138f9388a66496408f9c2bf6a6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gacae50138f9388a66496408f9c2bf6a6f">wiconnect::Wiconnect::setCommandDefaultTimeout</a> (<a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> timeoutMs)</td></tr>
+<tr class="memdesc:gacae50138f9388a66496408f9c2bf6a6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the default maximum time an API method may execute before terminating and return a timeout error code.  <a href="#gacae50138f9388a66496408f9c2bf6a6f">More...</a><br /></td></tr>
+<tr class="separator:gacae50138f9388a66496408f9c2bf6a6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gad8d98b8d2610f4ea564bede27e87857e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#gad8d98b8d2610f4ea564bede27e87857e">wiconnect::Wiconnect::getCommandDefaultTimeout</a> ()</td></tr>
+<tr class="memdesc:gad8d98b8d2610f4ea564bede27e87857e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current default maximum API execution time.  <a href="#gad8d98b8d2610f4ea564bede27e87857e">More...</a><br /></td></tr>
+<tr class="separator:gad8d98b8d2610f4ea564bede27e87857e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__settings.html#ga180b043ec83c53b5bf6b9ef2b187d08d">wiconnect::Wiconnect::setPinToGpioMapper</a> (PinToGpioMapper mapper)</td></tr>
 <tr class="memdesc:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a mapping function used to convert from a host Pin to WiConnect WiFi module GPIO.  <a href="#ga180b043ec83c53b5bf6b9ef2b187d08d">More...</a><br /></td></tr>
 <tr class="separator:ga180b043ec83c53b5bf6b9ef2b187d08d"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -143,12 +150,12 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <p>API getters/setters for core library settings. </p>
 <h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="gad5d31980a7b1e143f00b0117468c1a7e"></a>
+<a class="anchor" id="gad8d98b8d2610f4ea564bede27e87857e"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">int wiconnect::Wiconnect::getCommandDefaultTimeout </td>
+          <td class="memname"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a> wiconnect::Wiconnect::getCommandDefaultTimeout </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
@@ -304,14 +311,38 @@
 
 </div>
 </div>
-<a class="anchor" id="gaaaf8be221699870053ad98911b066a32"></a>
+<a class="anchor" id="ga851795595a422a14249b7ea9f0038c4c"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void wiconnect::Wiconnect::setBlockingEnabled </td>
+          <td>(</td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>blockingEnabled</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Sets if API calls are blocking or non-blocking. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">blockingEnabled</td><td>The new blocking value </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a class="anchor" id="gacae50138f9388a66496408f9c2bf6a6f"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">void wiconnect::Wiconnect::setCommandDefaultTimeout </td>
           <td>(</td>
-          <td class="paramtype">int&#160;</td>
+          <td class="paramtype"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a>&#160;</td>
           <td class="paramname"><em>timeoutMs</em></td><td>)</td>
           <td></td>
         </tr>
@@ -319,7 +350,7 @@
 </div><div class="memdoc">
 
 <p>Sets the default maximum time an API method may execute before terminating and return a timeout error code. </p>
-<dl class="section note"><dt>Note</dt><dd>All API methods (execpt some <a class="el" href="group__api__core__send__command.html#ga3a2637e5ce300a03c448edf1eff13c2c" title="Send command to WiConnect WiFi module. ">sendCommand()</a>) use this default value.</dd></dl>
+<dl class="section note"><dt>Note</dt><dd>All API methods (execpt some <a class="el" href="group__api__core__send__command.html#gadd23f2f86fcc0a438dad798ab3353505" title="Send command to WiConnect WiFi module. ">sendCommand()</a>) use this default value.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Default command timeout in milliseconds </td></tr>