Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_service_discoverer.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582

<!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>TB9.2 Example Applications: CServiceDiscoverer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CServiceDiscoverer Class Reference</h1><!-- doxytag: class="CServiceDiscoverer" -->
<p><a href="class_c_service_discoverer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#a5b2d0445970a22d19dfc40c88554646b">~CServiceDiscoverer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#ae75c6998eec994853effa62131ed1d48">DiscoverServicesOnDeviceL</a> (<a class="el" href="struct_t_device_data.html">TDeviceData</a> *aDevData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#a1b2f22f43eb02687b945e5e67ac4eae8">DiscoverServicesL</a> (TDeviceDataList *aDevDataList)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#accff779372cf2bc9bfaae0b5b5e35872">FinishDiscovery</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#ac5987a2bdca5e9dfc441c827e1b26e07">HasServices</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_service_discoverer.html">CServiceDiscoverer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#a2dad79c50af3415d82b76b8b61a5045a">NewL</a> (<a class="el" href="class_m_service_disco_observer.html">MServiceDiscoObserver</a> &amp;aObserver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_service_discoverer.html">CServiceDiscoverer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_discoverer.html#aa46a9c42ecbd7cb9976927b6858cb993">NewLC</a> (<a class="el" href="class_m_service_disco_observer.html">MServiceDiscoObserver</a> &amp;aObserver)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f53b55c19558df9a783b2a78891a22a"></a><!-- doxytag: member="CServiceDiscoverer::iRunning" ref="a5f53b55c19558df9a783b2a78891a22a" args="" -->
TBool&nbsp;</td><td class="memItemRight" valign="bottom"><b>iRunning</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="_service_discoverer_8h_source.html#l00034">34</a> of file <a class="el" href="_service_discoverer_8h_source.html">ServiceDiscoverer.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5b2d0445970a22d19dfc40c88554646b"></a><!-- doxytag: member="CServiceDiscoverer::~CServiceDiscoverer" ref="a5b2d0445970a22d19dfc40c88554646b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CServiceDiscoverer::~CServiceDiscoverer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_discoverer.html#a5b2d0445970a22d19dfc40c88554646b">~CServiceDiscoverer()</a></p>
<p>discussion Destroy the object and release all memory objects </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00036">36</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2dad79c50af3415d82b76b8b61a5045a"></a><!-- doxytag: member="CServiceDiscoverer::NewL" ref="a2dad79c50af3415d82b76b8b61a5045a" args="(MServiceDiscoObserver &amp;aObserver)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_service_discoverer.html">CServiceDiscoverer</a> * CServiceDiscoverer::NewL </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_m_service_disco_observer.html">MServiceDiscoObserver</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aObserver</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_discoverer.html#a2dad79c50af3415d82b76b8b61a5045a">NewL()</a></p>
<p>discussion Create new <a class="el" href="class_c_service_advertiser.html">CServiceAdvertiser</a> object return a pointer to the created instance of <a class="el" href="class_c_service_advertiser.html">CServiceAdvertiser</a> </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00009">9</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa46a9c42ecbd7cb9976927b6858cb993"></a><!-- doxytag: member="CServiceDiscoverer::NewLC" ref="aa46a9c42ecbd7cb9976927b6858cb993" args="(MServiceDiscoObserver &amp;aObserver)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_service_discoverer.html">CServiceDiscoverer</a> * CServiceDiscoverer::NewLC </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_m_service_disco_observer.html">MServiceDiscoObserver</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aObserver</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_discoverer.html#aa46a9c42ecbd7cb9976927b6858cb993">NewLC()</a> </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00017">17</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ae75c6998eec994853effa62131ed1d48"></a><!-- doxytag: member="CServiceDiscoverer::DiscoverServicesOnDeviceL" ref="ae75c6998eec994853effa62131ed1d48" args="(TDeviceData *aDevData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceDiscoverer::DiscoverServicesOnDeviceL </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_t_device_data.html">TDeviceData</a> *&nbsp;</td>
          <td class="paramname"> <em>aDevData</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>DiscoverServiceOnDeviceL()</p>
<p>discussion Discovers services on a given device. service discovery agent will be started to do the service discovery. search pattern will be used to limit the discovery for our services (matching service id).</p>
<p>param aDevData device data record </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00050">50</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a1b2f22f43eb02687b945e5e67ac4eae8"></a><!-- doxytag: member="CServiceDiscoverer::DiscoverServicesL" ref="a1b2f22f43eb02687b945e5e67ac4eae8" args="(TDeviceDataList *aDevDataList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceDiscoverer::DiscoverServicesL </td>
          <td>(</td>
          <td class="paramtype">TDeviceDataList *&nbsp;</td>
          <td class="paramname"> <em>aDevDataList</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>DiscoverServiceOnDeviceL()</p>
<p>discussion Starts service discovery for all given devices.</p>
<p>param aDevDataList list of devices to do the service discovery for. </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00082">82</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="accff779372cf2bc9bfaae0b5b5e35872"></a><!-- doxytag: member="CServiceDiscoverer::FinishDiscovery" ref="accff779372cf2bc9bfaae0b5b5e35872" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceDiscoverer::FinishDiscovery </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_discoverer.html#accff779372cf2bc9bfaae0b5b5e35872">FinishDiscovery()</a></p>
<p>discussion Stops the service discovery, stops the discovery agent.</p>
<p>param aDevData device data record </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00098">98</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ac5987a2bdca5e9dfc441c827e1b26e07"></a><!-- doxytag: member="CServiceDiscoverer::HasServices" ref="ac5987a2bdca5e9dfc441c827e1b26e07" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TBool CServiceDiscoverer::HasServices </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_discoverer.html#ac5987a2bdca5e9dfc441c827e1b26e07">HasServices()</a></p>
<p>discussion check if any services were discovered.</p>
<p>return true if any usable services were discovered. </p>

<p>Definition at line <a class="el" href="_service_discoverer_8cpp_source.html#l00279">279</a> of file <a class="el" href="_service_discoverer_8cpp_source.html">ServiceDiscoverer.cpp</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>