http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/e98b0c12/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html new file mode 100644 index 0000000..fbc3c58 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/index.html @@ -0,0 +1,722 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_conn_find/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_conn_find - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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_gap_conn_find"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</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"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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 + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_conn_find</a> + </li> + + + + + + <li > + <a href="../ble_gap_connect/">ble_gap_connect</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc/">ble_gap_disc</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_active/">ble_gap_disc_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_cancel/">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_conn_find</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95conn95find"><font color="#F2853F" style="font-size:24pt">ble_gap_conn_find</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_conn_find</span>(<span style="color: #A90D91">uint16_t</span> <span style="color: #000000">handle</span>, <span style="color: #A90D91">struct</span> <span style="color: #000000">ble_gap_conn_desc</span> <span style="color: #000000">*out_desc</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Searches for a connection with the specified handle. If a matching connection is found, the supplied connection descriptor is filled correspondingly. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>handle</td> +<td>The connection handle to search for.</td> +</tr> +<tr> +<td>out_desc</td> +<td>On success, this is populated with information relating to the matching connection. Pass NULL if you don't need this information.</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_ENOTCONN</td> +<td>No matching connection was found.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gap_conn_cancel/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_conn_cancel + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_connect/> + Next: ble_gap_connect + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <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> + </div> + </div> +</footer> + </div> + </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/e98b0c12/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html new file mode 100644 index 0000000..4c29444 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/index.html @@ -0,0 +1,745 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_connect/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_connect - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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_gap_connect"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</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"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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 + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_find/">ble_gap_conn_find</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_connect</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc/">ble_gap_disc</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_active/">ble_gap_disc_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_cancel/">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_connect</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95connect"><font color="#F2853F" style="font-size:24pt">ble_gap_connect</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_connect</span>(<span style="color: #A90D91">uint8_t</span> <span style="color: #000000">own_addr_type</span>, + <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">peer_addr_type</span>, <span style="color: #A90D91">const</span> <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">*peer_addr</span>, + <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">ble_gap_conn_params</span> <span style="color: #000000">*conn_params</span>, + <span style="color: #000000">ble_gap_event_fn</span> <span style="color: #000000">*cb</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*cb_arg</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Initiates a connect procedure. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>own_addr_type</td> +<td>The type of address the stack should use for itself during connection establishment. <ul><li>BLE_ADDR_TYPE_PUBLIC</li> <li>BLE_ADDR_TYPE_RANDOM</li> <li>BLE_ADDR_TYPE_RPA_PUB_DEFAULT</li> <li>BLE_ADDR_TYPE_RPA_RND_DEFAULT</li></ul></td> +</tr> +<tr> +<td>peer_addr_type</td> +<td>The peer's address type. One of: <ul><li>BLE_HCI_CONN_PEER_ADDR_PUBLIC</li> <li>BLE_HCI_CONN_PEER_ADDR_RANDOM</li> <li>BLE_HCI_CONN_PEER_ADDR_PUBLIC_IDENT</li> <li>BLE_HCI_CONN_PEER_ADDR_RANDOM_IDENT</li> <li>BLE_GAP_ADDR_TYPE_WL</li></ul></td> +</tr> +<tr> +<td>peer_addr</td> +<td>The identity address of the peer to connect to. This parameter is ignored when the white list is used.</td> +</tr> +<tr> +<td>duration_ms</td> +<td>The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds.</td> +</tr> +<tr> +<td>conn_params</td> +<td>Additional arguments specifying the particulars of the connect procedure. Specify null for default values.</td> +</tr> +<tr> +<td>cb</td> +<td>The callback to associate with this connect procedure. When the connect procedure completes, the result is reported through this callback. If the connect procedure succeeds, the connection inherits this callback as its event-reporting mechanism.</td> +</tr> +<tr> +<td>cb_arg</td> +<td>The optional argument to pass to the callback function.</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-core">BLE host 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_gap_conn_find/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_conn_find + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_disc/> + Next: ble_gap_disc + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <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> + </div> + </div> +</footer> + </div> + </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/e98b0c12/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html new file mode 100644 index 0000000..64dd642 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/index.html @@ -0,0 +1,736 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_disc/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_disc - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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_gap_disc"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</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"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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 + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_find/">ble_gap_conn_find</a> + </li> + + + + + + <li > + <a href="../ble_gap_connect/">ble_gap_connect</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_disc</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_active/">ble_gap_disc_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_cancel/">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_disc</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95disc"><font color="#F2853F" style="font-size:24pt">ble_gap_disc</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_disc</span>(<span style="color: #A90D91">uint8_t</span> <span style="color: #000000">own_addr_type</span>, <span style="color: #A90D91">int32_t</span> <span style="color: #000000">duration_ms</span>, + <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #000000">ble_gap_disc_params</span> <span style="color: #000000">*disc_params</span>, + <span style="color: #000000">ble_gap_event_fn</span> <span style="color: #000000">*cb</span>, <span style="color: #A90D91">void</span> <span style="color: #000000">*cb_arg</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Performs the Limited or General Discovery Procedures. </p> +<h3 id="parameters">Parameters</h3> +<table> +<thead> +<tr> +<th><em>Parameter</em></th> +<th><em>Description</em></th> +</tr> +</thead> +<tbody> +<tr> +<td>own_addr_type</td> +<td>The type of address the stack should use for itself when sending scan requests. Valid values are: <ul><li>BLE_ADDR_TYPE_PUBLIC</li> <li>BLE_ADDR_TYPE_RANDOM</li> <li>BLE_ADDR_TYPE_RPA_PUB_DEFAULT</li> <li>BLE_ADDR_TYPE_RPA_RND_DEFAULT</li></ul> This parameter is ignored unless active scanning is being used.</td> +</tr> +<tr> +<td>duration_ms</td> +<td>The duration of the discovery procedure. On expiration, the procedure ends and a BLE_GAP_EVENT_DISC_COMPLETE event is reported. Units are milliseconds. Specify BLE_HS_FOREVER for no expiration.</td> +</tr> +<tr> +<td>disc_params</td> +<td>Additional arguments specifying the particulars of the discovery procedure.</td> +</tr> +<tr> +<td>cb</td> +<td>The callback to associate with this discovery procedure. Advertising reports and discovery termination events are reported through this callback.</td> +</tr> +<tr> +<td>cb_arg</td> +<td>The optional argument to pass to the callback function.</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-core">BLE host 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_gap_connect/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_connect + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_disc_active/> + Next: ble_gap_disc_active + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <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> + </div> + </div> +</footer> + </div> + </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/e98b0c12/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html new file mode 100644 index 0000000..40759dc --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/index.html @@ -0,0 +1,705 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_active/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_disc_active - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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_gap_disc_active"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</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"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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 + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_find/">ble_gap_conn_find</a> + </li> + + + + + + <li > + <a href="../ble_gap_connect/">ble_gap_connect</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc/">ble_gap_disc</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_disc_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_cancel/">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_disc_active</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95disc95active"><font color="#F2853F" style="font-size:24pt">ble_gap_disc_active</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_disc_active</span>(<span style="color: #A90D91">void</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Indicates whether a discovery procedure is currently in progress. </p> +<h3 id="parameters">Parameters</h3> +<p>None</p> +<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>No discovery procedure in progress.</td> +</tr> +<tr> +<td>1</td> +<td>Discovery procedure in progress.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gap_disc/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_disc + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_disc_cancel/> + Next: ble_gap_disc_cancel + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <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> + </div> + </div> +</footer> + </div> + </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/e98b0c12/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html ---------------------------------------------------------------------- diff --git a/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html new file mode 100644 index 0000000..a9b2566 --- /dev/null +++ b/develop/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/index.html @@ -0,0 +1,709 @@ +<!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"> + + + <link rel="canonical" href="http://mynewt.apache.org/network/ble/ble_hs/ble_gap/functions/ble_gap_disc_cancel/";> + <link rel="shortcut icon" href="../../../../../../img/favicon.ico"> + + <title>ble_gap_disc_cancel - Apache Mynewt</title> + + <link href="../../../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> + <link href="../../../../../../css/font-awesome-4.0.3.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=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'> + <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_gap_disc_cancel"> + + + + + + + + + +<nav id="navbar" class="navbar navbar-inverse navbar-fixed-top" 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="/">Home</a> + </li> + <li + class="important" +> + <a href="/quick-start/">Quick Start</a> + </li> + <li + class="" +> + <a href="/about/">About</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"><div id="docSidebar" class="hidden-print" role="complementary"> + <div class="top"> + <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt"> + <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 + </option> + + <option + value="/v0_9_0/os/introduction" + + > + Version: 0.9.0 (latest) + </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/">GAP</a> + + + <ul> + + + + + + + + <li><a href=" + ../../definitions/ble_gap_defs/ +">Definitions</a> + + + </li> + + + + + + + + <li><a href=" + ../ble_gap_adv_active/ +">Functions</a> + + + <ul> + + + + <li > + <a href="../ble_gap_adv_active/">ble_gap_adv_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_rsp_set_fields/">ble_gap_adv_rsp_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_set_fields/">ble_gap_adv_set_fields</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_start/">ble_gap_adv_start</a> + </li> + + + + + + <li > + <a href="../ble_gap_adv_stop/">ble_gap_adv_stop</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_active/">ble_gap_conn_active</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_cancel/">ble_gap_conn_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_conn_find/">ble_gap_conn_find</a> + </li> + + + + + + <li > + <a href="../ble_gap_connect/">ble_gap_connect</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc/">ble_gap_disc</a> + </li> + + + + + + <li > + <a href="../ble_gap_disc_active/">ble_gap_disc_active</a> + </li> + + + + + + <li class="active"> + <a href="./">ble_gap_disc_cancel</a> + </li> + + + + + + <li > + <a href="../ble_gap_security_initiate/">ble_gap_security_initiate</a> + </li> + + + + + + <li > + <a href="../ble_gap_terminate/">ble_gap_terminate</a> + </li> + + + + + + <li > + <a href="../ble_gap_update_params/">ble_gap_update_params</a> + </li> + + + + + + <li > + <a href="../ble_gap_wl_set/">ble_gap_wl_set</a> + </li> + + + + </ul> + + </li> + + + + </ul> + + </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="../../../other/other/">Other</a> + + + </li> + + + + </ul> + + </li> + + + + + + + + <li ><a href="../../../../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="show-sidebar-container"> + <button class="show-sidebar">Docs Menu</button> + </div> + + <div class="col-md-9" role="main"> + <div class="row doc-header"> + <div class="col-sm-12"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs pull-right"> + <li><a href="/develop/os/introduction">Docs</a></li> + + + + <li>» <a href="../../ble_gap/">GAP</a></li> + + + + <li>» <a href="../ble_gap_adv_active/">Functions</a></li> + + + + <li>» ble_gap_disc_cancel</li> + + + + </ul> +</div> + </div> + </div> + + <h2 id="ble95gap95disc95cancel"><font color="#F2853F" style="font-size:24pt">ble_gap_disc_cancel</font></h2> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> +<span style="color: #000000">ble_gap_disc_cancel</span>(<span style="color: #A90D91">void</span>) +</pre></div> + + +<h3 id="description">Description</h3> +<p>Cancels the discovery procedure currently in progress. A success return code indicates that scanning has been fully aborted; a new discovery or connect procedure can be initiated immediately. </p> +<h3 id="parameters">Parameters</h3> +<p>None</p> +<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_EALREADY</td> +<td>There is no discovery procedure to cancel.</td> +</tr> +<tr> +<td>other</td> +<td>Other nonzero on unexpected error.</td> +</tr> +</tbody> +</table> + + <div class="row"> + + + + +<ul class="nav nav-pills" style="margin-bottom: 10px"> + <li> + + <a href=../ble_gap_disc_active/> + <span class="fa fa-arrow-left"></span> + Previous: ble_gap_disc_active + </a> + + </li> + <li class="pull-right"> + + <a href=../ble_gap_security_initiate/> + Next: ble_gap_security_initiate + <span class="fa fa-arrow-right"></span> + </a> + + </li> +</ul> + </div> + <div class="row"> + <footer> + <div class="row"> + <div class="col-md-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.<br>The Apache Software Foundation Apache Incubator</p> + + </div> + </div> + <div class="copyright-logos"> + <div class="row"> + <div class="col-xs-6 text-right"> + <img src="/img/apache-feather.png" alt="Apache" title="Apache"> + </div> + <div class="col-xs-6 text-left"> + <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator"> + </div> + </div> + </div> + <div class="row"> + <div class="col-md-12"> + <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> + </div> + </div> +</footer> + </div> + </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
