snapshot
/
qbluetooth


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QBluetoothZero: QBtServiceAdvertiser Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="projecticonBlue.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">QBluetoothZero
   &#160;<span id="projectnumber">2.0</span>
   </div>
   
  </td>
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_q_bt_service_advertiser.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#signals">Signals</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">QBtServiceAdvertiser Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="QBtServiceAdvertiser" -->
<p><code>#include &lt;<a class="el" href="_q_bt_service_advertiser_8h_source.html">QBtServiceAdvertiser.h</a>&gt;</code></p>

<p><a href="class_q_bt_service_advertiser-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#ac39681f728f298e62f454c300986e9dc">ErrorCodes</a> { <a class="el" href="class_q_bt_service_advertiser.html#ac39681f728f298e62f454c300986e9dca7fa1da449c970420bd4f945f04fd2ad1">FeatureNotSupported</a>
 }</td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#ad3b82bfa197b6ee4454082b4ebe7de6b">advertisingStarted</a> (const <a class="el" href="class_q_bt_service.html">QBtService</a> &amp;service)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#ae558995770fb8cd412d323d9f698577b">advertisingStopped</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#a85030e58651d3a26612e4faaf0ea1f4d">error</a> (<a class="el" href="class_q_bt_service_advertiser.html#ac39681f728f298e62f454c300986e9dc">QBtServiceAdvertiser::ErrorCodes</a> code)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#abca729be0ce7e8172b43e93c60c12930">QBtServiceAdvertiser</a> (QObject *parent)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#ade8a2e04133e9cc861d2ff68af8b9f36">~QBtServiceAdvertiser</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#a52bc79594aefff3eb687688b4fdb4fad">startAdvertising</a> (const <a class="el" href="class_q_bt_service.html">QBtService</a> &amp;service)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#a2d1b758ed89dbc8c8a119e6f4e93fb2c">stopAdvertising</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#a90121494e3339dfc6fa9cd3a97a00368">updateAvailability</a> (bool aAvailable)</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_bt_service_advertiser.html#a65fb8bc401be7c642ddbe27635eef2da">QBtServiceAdvertiserPrivate</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class responsible to advertise a given bluetooth service.</p>
<p>After the instantiation of the class, <a class="el" href="class_q_bt_service_advertiser.html#a52bc79594aefff3eb687688b4fdb4fad">startAdvertising(const QBtService&amp;)</a> can be callled to start advertising the given bluetooth service. If successfull then <a class="el" href="class_q_bt_service_advertiser.html#ad3b82bfa197b6ee4454082b4ebe7de6b">advertisingStarted(const QBtService&amp;)</a> signal is emitted.</p>
<p>At any time <a class="el" href="class_q_bt_service_advertiser.html#a2d1b758ed89dbc8c8a119e6f4e93fb2c">stopAdvertising()</a> can be called to stop the advertising and remove the registered service from the SDP database. If successfull then <a class="el" href="class_q_bt_service_advertiser.html#ae558995770fb8cd412d323d9f698577b">advertisingStopped()</a> is emitted.</p>
<p>If user wants to temporarily deactive the service advertisement then he can call <a class="el" href="class_q_bt_service_advertiser.html#a90121494e3339dfc6fa9cd3a97a00368">updateAvailability(bool)</a> (instead of the <a class="el" href="class_q_bt_service_advertiser.html#a2d1b758ed89dbc8c8a119e6f4e93fb2c">stopAdvertising()</a> that stops the advertising permanently).</p>
<p>In case of error, <a class="el" href="class_q_bt_service_advertiser.html#a85030e58651d3a26612e4faaf0ea1f4d">error(ErrorCodes)</a> signal is emitted.</p>
<p>For integrity reasons, at destruction stops the advertising causing the service to be deleted from the SDP database.</p>
<p>NOTE: Currently there is no implementation on the Windows platform so after the intatiation of this object, any call to any function will emit an error(QBtServiceAdvertiser::FeatureNotSupported) signal. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ac39681f728f298e62f454c300986e9dc"></a><!-- doxytag: member="QBtServiceAdvertiser::ErrorCodes" ref="ac39681f728f298e62f454c300986e9dc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_q_bt_service_advertiser.html#ac39681f728f298e62f454c300986e9dc">QBtServiceAdvertiser::ErrorCodes</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ac39681f728f298e62f454c300986e9dca7fa1da449c970420bd4f945f04fd2ad1"></a><!-- doxytag: member="FeatureNotSupported" ref="ac39681f728f298e62f454c300986e9dca7fa1da449c970420bd4f945f04fd2ad1" args="" -->FeatureNotSupported</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abca729be0ce7e8172b43e93c60c12930"></a><!-- doxytag: member="QBtServiceAdvertiser::QBtServiceAdvertiser" ref="abca729be0ce7e8172b43e93c60c12930" args="(QObject *parent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QBtServiceAdvertiser::QBtServiceAdvertiser </td>
          <td>(</td>
          <td class="paramtype">QObject *&#160;</td>
          <td class="paramname"><em>parent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ade8a2e04133e9cc861d2ff68af8b9f36"></a><!-- doxytag: member="QBtServiceAdvertiser::~QBtServiceAdvertiser" ref="ade8a2e04133e9cc861d2ff68af8b9f36" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QBtServiceAdvertiser::~QBtServiceAdvertiser </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3b82bfa197b6ee4454082b4ebe7de6b"></a><!-- doxytag: member="QBtServiceAdvertiser::advertisingStarted" ref="ad3b82bfa197b6ee4454082b4ebe7de6b" args="(const QBtService &amp;service)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::advertisingStarted </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_q_bt_service.html">QBtService</a> &amp;&#160;</td>
          <td class="paramname"><em>service</em></td><td>)</td>
          <td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The signal is emitted if the transmittion of the service is started </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">service</td><td>A reference to an object containing all the info of the service being transmitted. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae558995770fb8cd412d323d9f698577b"></a><!-- doxytag: member="QBtServiceAdvertiser::advertisingStopped" ref="ae558995770fb8cd412d323d9f698577b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::advertisingStopped </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The signal is emitted when the transmittion of the service ends. </p>

</div>
</div>
<a class="anchor" id="a85030e58651d3a26612e4faaf0ea1f4d"></a><!-- doxytag: member="QBtServiceAdvertiser::error" ref="a85030e58651d3a26612e4faaf0ea1f4d" args="(QBtServiceAdvertiser::ErrorCodes code)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::error </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_q_bt_service_advertiser.html#ac39681f728f298e62f454c300986e9dc">QBtServiceAdvertiser::ErrorCodes</a>&#160;</td>
          <td class="paramname"><em>code</em></td><td>)</td>
          <td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Emitted in case of error (not implemented). </p>

</div>
</div>
<a class="anchor" id="a52bc79594aefff3eb687688b4fdb4fad"></a><!-- doxytag: member="QBtServiceAdvertiser::startAdvertising" ref="a52bc79594aefff3eb687688b4fdb4fad" args="(const QBtService &amp;service)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::startAdvertising </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_q_bt_service.html">QBtService</a> &amp;&#160;</td>
          <td class="paramname"><em>service</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Starts the service advertiser.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">service</td><td>the service class that contains all the necessery information for transmitting the service </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a2d1b758ed89dbc8c8a119e6f4e93fb2c"></a><!-- doxytag: member="QBtServiceAdvertiser::stopAdvertising" ref="a2d1b758ed89dbc8c8a119e6f4e93fb2c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::stopAdvertising </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Stops the transmittion of the service running (if any) </p>

</div>
</div>
<a class="anchor" id="a90121494e3339dfc6fa9cd3a97a00368"></a><!-- doxytag: member="QBtServiceAdvertiser::updateAvailability" ref="a90121494e3339dfc6fa9cd3a97a00368" args="(bool aAvailable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QBtServiceAdvertiser::updateAvailability </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>aAvailable</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Change the availability of the service. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aAvailable</td><td>If true, the service is transmitted. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a65fb8bc401be7c642ddbe27635eef2da"></a><!-- doxytag: member="QBtServiceAdvertiser::QBtServiceAdvertiserPrivate" ref="a65fb8bc401be7c642ddbe27635eef2da" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class QBtServiceAdvertiserPrivate<code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_q_bt_service_advertiser_8h_source.html">QBtServiceAdvertiser.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="class_q_bt_service_advertiser.html">QBtServiceAdvertiser</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">Generated on Wed Jan 4 2012 21:05:39 for QBluetoothZero by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>