http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/latest/network/ble/ble_hs/ble_att/ble_att/index.html ---------------------------------------------------------------------- diff --git a/latest/network/ble/ble_hs/ble_att/ble_att/index.html b/latest/network/ble/ble_hs/ble_att/ble_att/index.html new file mode 100644 index 0000000..6c885d0 --- /dev/null +++ b/latest/network/ble/ble_hs/ble_att/ble_att/index.html @@ -0,0 +1,577 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_att/ble_att/";> --> + <link rel="shortcut icon" href="../../../../../img/favicon.ico"> + + <title>toc - Apache Mynewt</title> + + <link href="../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../css/highlight.css"> + <link href="../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="toc"> + + + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li class="active"><a href="./">ATT</a> + + + <ul> + + + + + + + + <li><a href=" + ../functions/ble_att_mtu/ +">Functions</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../bletiny/bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_hs/">NimBLE Host API</a></li> + + + + <li>» ATT</li> + + + + + + </ul> +</div> + </div> + + <h2 id="nimble-host-att-client-reference"><font color="F2853F" style="font-size:24pt">NimBLE Host ATT Client Reference</font></h2> +<h3 id="introduction">Introduction</h3> +<p>The Attribute Protocol (ATT) is a mid-level protocol that all BLE devices use to exchange data. Data is exchanged when an ATT client reads or writes an attribute belonging to an ATT server. Any device that needs to send or receive data must support both the client and server functionality of the ATT protocol. The only devices which do not support ATT are the most basic ones: broadcasters and observers (i.e., beaconing devices and listening devices).</p> +<p>Most ATT functionality is not interesting to an application. Rather than use ATT directly, an application uses the higher level GATT profile, which sits directly above ATT in the host. NimBLE exposes the few bits of ATT functionality which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE host exposes to the application.</p> +<h3 id="header">Header</h3> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #633820">#include "host/ble_hs.h"</span> +</pre></div> + + +<h3 id="definitions">Definitions</h3> +<p>None.</p> +<table> +<thead> +<tr> +<th>Function</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td><a href="../functions/ble_att_mtu/">ble_att_mtu</a></td> +<td>Retrieves the ATT MTU of the specified connection.</td> +</tr> +<tr> +<td><a href="../functions/ble_att_set_preferred_mtu/">ble_att_set_preferred_mtu</a></td> +<td>Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges.</td> +</tr> +<tr> +<td><a href="../functions/ble_att_svr_read_local/">ble_att_svr_read_local</a></td> +<td>Reads a locally registered attribute.</td> +</tr> +<tr> +<td><a href="../functions/ble_att_svr_write_local/">ble_att_svr_write_local</a></td> +<td>Writes a locally registered attribute.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../../ble_hs_id/functions/ble_hs_id_set_rnd/> + <span class="fa fa-arrow-left"></span> + Previous: ble_hs_id_set_rnd + </a> + + </li> + <li class="pull-right"> + + <a href=../functions/ble_att_mtu/> + Next: ble_att_mtu + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../js/highlight.pack.js"></script> + <script src="../../../../../js/base.js"></script> + <script src="../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/latest/network/ble/ble_hs/ble_att/functions/ble_att_mtu/index.html ---------------------------------------------------------------------- diff --git a/latest/network/ble/ble_hs/ble_att/functions/ble_att_mtu/index.html b/latest/network/ble/ble_hs/ble_att/functions/ble_att_mtu/index.html new file mode 100644 index 0000000..dcbbbf1 --- /dev/null +++ b/latest/network/ble/ble_hs/ble_att/functions/ble_att_mtu/index.html @@ -0,0 +1,603 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_att/functions/ble_att_mtu/";> --> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_att_mtu - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../../css/highlight.css"> + <link href="../../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="ble_att_mtu"> + + + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../ble_att/">ATT</a> + + + <ul> + + + + + + + + <li><a href=" + ./ +">Functions</a> + + + <ul> + + + + <li class="active"> + <a href="./">ble_att_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_set_preferred_mtu/">ble_att_set_preferred_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_read_local/">ble_att_svr_read_local</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_write_local/">ble_att_svr_write_local</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../bletiny/bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_att/">ATT</a></li> + + + + <li>» Functions</li> + + + + <li>» ble_att_mtu</li> + + + + </ul> +</div> + </div> + + <h2 id="ble95att95mtu"><font color="#F2853F" style="font-size:24pt">ble_att_mtu</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">uint16_t</span> +<span style="color: #000000">ble_att_mtu</span>(<span style="color: #A90D91">uint16_t</span> <span style="color: #000000">conn_handle</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Retrieves the ATT MTU of the specified connection. If an MTU exchange for this connection has occurred, the MTU is the lower of the two peers' preferred values. Otherwise, the MTU is the default value of 23.</p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>conn_handle</td> +<td>The handle of the connection to query.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<p>The specified connection's ATT MTU.</p> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../../ble_att/> + <span class="fa fa-arrow-left"></span> + Previous: ATT + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_att_set_preferred_mtu/> + Next: ble_att_set_preferred_mtu + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../../js/highlight.pack.js"></script> + <script src="../../../../../../js/base.js"></script> + <script src="../../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/latest/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu/index.html ---------------------------------------------------------------------- diff --git a/latest/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu/index.html b/latest/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu/index.html new file mode 100644 index 0000000..d0eab5b --- /dev/null +++ b/latest/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu/index.html @@ -0,0 +1,620 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_att/functions/ble_att_set_preferred_mtu/";> --> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_att_set_preferred_mtu - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../../css/highlight.css"> + <link href="../../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="ble_att_set_preferred_mtu"> + + + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../ble_att/">ATT</a> + + + <ul> + + + + + + + + <li><a href=" + ../ble_att_mtu/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_att_mtu/">ble_att_mtu</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_att_set_preferred_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_read_local/">ble_att_svr_read_local</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_write_local/">ble_att_svr_write_local</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../bletiny/bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_att/">ATT</a></li> + + + + <li>» <a href="../ble_att_mtu/">Functions</a></li> + + + + <li>» ble_att_set_preferred_mtu</li> + + + + </ul> +</div> + </div> + + <h2 id="ble95att95set95preferred95mtu"><font color="#F2853F" style="font-size:24pt">ble_att_set_preferred_mtu</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_att_set_preferred_mtu</span>(<span style="color: #A90D91">uint16_t</span> <span style="color: #000000">mtu</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Sets the preferred ATT MTU; the device will indicate this value in all subseqeunt ATT MTU exchanges. The ATT MTU of a connection is equal to the lower of the two peers' preferred MTU values. The ATT MTU is what dictates the maximum size of any message sent during a GATT procedure. The specified MTU must be within the following range: [23, BLE_ATT_MTU_MAX]. 23 is a minimum imposed by the Bluetooth specification; BLE_ATT_MTU_MAX is a NimBLE compile-time setting.</p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>mtu</td> +<td>The preferred ATT MTU.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td>BLE_HS_EINVAL</td> +<td>The specifeid value is not within the allowed range.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_att_mtu/> + <span class="fa fa-arrow-left"></span> + Previous: ble_att_mtu + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_att_svr_read_local/> + Next: ble_att_svr_read_local + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../../js/highlight.pack.js"></script> + <script src="../../../../../../js/base.js"></script> + <script src="../../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local/index.html ---------------------------------------------------------------------- diff --git a/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local/index.html b/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local/index.html new file mode 100644 index 0000000..ab70d52 --- /dev/null +++ b/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local/index.html @@ -0,0 +1,631 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_att/functions/ble_att_svr_read_local/";> --> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_att_svr_read_local - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../../css/highlight.css"> + <link href="../../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="ble_att_svr_read_local"> + + + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../ble_att/">ATT</a> + + + <ul> + + + + + + + + <li><a href=" + ../ble_att_mtu/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_att_mtu/">ble_att_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_set_preferred_mtu/">ble_att_set_preferred_mtu</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_att_svr_read_local</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_write_local/">ble_att_svr_write_local</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../bletiny/bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_att/">ATT</a></li> + + + + <li>» <a href="../ble_att_mtu/">Functions</a></li> + + + + <li>» ble_att_svr_read_local</li> + + + + </ul> +</div> + </div> + + <h2 id="ble95att95svr95read95local"><font color="#F2853F" style="font-size:24pt">ble_att_svr_read_local</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_att_svr_read_local</span>( + <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">attr_handle</span>, + <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">**out_om</span> +) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Reads a locally registered attribute. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the read is performed by calling the registered GATT access callback.</p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>attr_handle</td> +<td>The 16-bit handle of the attribute to read.</td> +</tr> +<tr> +<td>out_om</td> +<td>On success, this is made to point to a newly-allocated mbuf containing the attribute data read.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-att">ATT return code</a></td> +<td>The attribute access callback reports failure.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-core">Core return code</a></td> +<td>Unexpected error.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_att_set_preferred_mtu/> + <span class="fa fa-arrow-left"></span> + Previous: ble_att_set_preferred_mtu + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_att_svr_write_local/> + Next: ble_att_svr_write_local + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../../js/highlight.pack.js"></script> + <script src="../../../../../../js/base.js"></script> + <script src="../../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/89c943e1/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local/index.html ---------------------------------------------------------------------- diff --git a/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local/index.html b/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local/index.html new file mode 100644 index 0000000..1bb5920 --- /dev/null +++ b/latest/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local/index.html @@ -0,0 +1,631 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + <!-- This is broken by doc revisioning. + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_att/functions/ble_att_svr_write_local/";> --> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_att_svr_write_local - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link rel="stylesheet" href="../../../../../../css/highlight.css"> + <link href="../../../../../../css/base.css" rel="stylesheet"> + <link href="../../../../../../css/custom.css" rel="stylesheet"> + <link href="../../../../../../css/v2.css" rel="stylesheet"> + <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> + <link href="../../../../../../extra.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> + <![endif]--> + + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-72162311-1', 'auto'); + ga('send', 'pageview'); + </script> + + </head> + + + <body class="ble_att_svr_write_local"> + + + <div class="container"> + <div class="row v2-main-banner"> + <div class="col-xs-12 v2-vcenter"> + <a href="/"><img class="logo" src="/img/logo.png"></a> + + <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> + </div> + </div> +</div> + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> + <div class="container"> + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav navbar-right"> + <li + class="" +> + <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</a> + </li> + <li + class="" +> + <a href="/talks/">Talks</a> + </li> + <li + class="active" +> + <a href="/latest/os/introduction">Documentation</a> + </li> + <li + class="" +> + <a href="/download/">Download</a> + </li> + <li + class="" +> + <a href="/community/">Community</a> + </li> + <li + class="" +> + <a href="/events/">Events</a> + </li> + </ul> + + <!-- Search, Navigation and Repo links --> + <ul class="nav navbar-nav navbar-right"> + + </ul> + </div> + </div> +</nav> + + + + <div class="container"> + + <div class="row"> + <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search documentation" /> + </div> + </form> + </div> + </div> + <ul class="toc-nav"> + <li class="doc-version"> +<select class="form-control" onchange="if (this.value) window.location.href=this.value"> + + <option + value="/develop/os/introduction" + selected="selected" + > + Version: develop (latest) + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 + </option> + +</select> +</li> + + + + + + + + + + + + + + + + + + + + + + <li ><a href="../../../../../../os/introduction/">Mynewt Documentation</a> + + + <ul> + + + + + + + + <li ><a href="../../../../../../os/get_started/get_started/">Basic Setup</a> + + + </li> + + + + + + <li > + <a href="../../../../../../os/get_started/vocabulary/">Concepts</a> + </li> + + + + + + + + <li ><a href="../../../../../../os/tutorials/tutorials/">Tutorials</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../os/os_user_guide/">OS User Guide</a> + + + </li> + + + + + + + + <li><a href=" + ../../../../ble_intro/ +">BLE User Guide</a> + + + <ul> + + + + <li > + <a href="../../../../ble_intro/">NimBLE Introduction</a> + </li> + + + + + + <li > + <a href="../../../../ble_sec/">NimBLE Security</a> + </li> + + + + + + <li > + <a href="../../../../nimble_setup/">Set up application</a> + </li> + + + + + + + + <li ><a href="../../../../ini_stack/ble_ini_intro/">Initialize stack</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs/">NimBLE Host API</a> + + + <ul> + + + + + + <li > + <a href="../../../ble_hs_return_codes/">Return codes</a> + </li> + + + + + + + + <li ><a href="../../../init/init/">Init and config</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gap/ble_gap/">GAP</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gattc/ble_gattc/">GATT client</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_gatts/ble_gatts/">GATT server</a> + + + </li> + + + + + + + + <li ><a href="../../../ble_hs_id/ble_hs_id/">Identity</a> + + + </li> + + + + + + + + <li ><a href="../../ble_att/">ATT</a> + + + <ul> + + + + + + + + <li><a href=" + ../ble_att_mtu/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_att_mtu/">ble_att_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_set_preferred_mtu/">ble_att_set_preferred_mtu</a> + </li> + + + + + + <li > + <a href="../ble_att_svr_read_local/">ble_att_svr_read_local</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_att_svr_write_local</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../bletiny/bletiny_api/">bletiny app Usage API</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../../../newt/newt_intro/">Newt Tool Guide</a> + + + </li> + + + + + + + + <li ><a href="../../../../../../newtmgr/overview/">Newt Manager Guide</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li><a href=" + ../../../../../../faq/how_to_edit_docs/ +">Appendix</a> + + + </li> + + + + </ul> +</div></div> + + <div class="col-md-9" role="main"> + <div class="doc-header"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/latest/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_att/">ATT</a></li> + + + + <li>» <a href="../ble_att_mtu/">Functions</a></li> + + + + <li>» ble_att_svr_write_local</li> + + + + </ul> +</div> + </div> + + <h2 id="ble95att95svr95write95local"><font color="#F2853F" style="font-size:24pt">ble_att_svr_write_local</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_att_svr_write_local</span>( + <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">attr_handle</span>, + <span style="color: #A90D91">struct</span> <span style="color: #000000">os_mbuf</span> <span style="color: #000000">*om</span> +) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Writes a locally registered attribute. This function consumes the supplied mbuf regardless of the outcome. If the specified attribute handle coresponds to a GATT characteristic value or descriptor, the write is performed by calling the registered GATT access callback.</p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>attr_handle</td> +<td>The 16-bit handle of the attribute to write.</td> +</tr> +<tr> +<td>om</td> +<td>The value to write to the attribute.</td> +</tr> +</tbody> +</table> +<h3 id="returned-values">Returned values</h3> +<table> +<thead> +<tr> +<th><em>Value</em></th> +<th><em>Condition</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>0</td> +<td>Success.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-att">ATT return code</a></td> +<td>The attribute access callback reports failure.</td> +</tr> +<tr> +<td><a href="../../../ble_hs_return_codes/#return-codes-core">Core return code</a></td> +<td>Unexpected error.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_att_svr_read_local/> + <span class="fa fa-arrow-left"></span> + Previous: ble_att_svr_read_local + </a> + + </li> + <li class="pull-right"> + + <a href=../../../other/other/> + Next: Other + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <footer class="row"> + <div class="col-xs-12"> + + <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + + </div> + <div class="col-xs-12"> + <div class="logos"> + <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> + <small class="footnote"> + MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. + </small> + <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> +</footer> + </div> + </div> + + + </div> + + <script src="../../../../../../js/jquery-1.10.2.min.js"></script> + <script src="../../../../../../js/bootstrap-3.0.3.min.js"></script> + <script src="../../../../../../js/highlight.pack.js"></script> + <script src="../../../../../../js/base.js"></script> + <script src="../../../../../../js/custom.js"></script> + + </body> +</html> \ No newline at end of file
