Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_device_discoverer.html
changeset 6 43e37759235e
equal deleted inserted replaced
5:f345bda72bc4 6:43e37759235e
       
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     2 <html xmlns="http://www.w3.org/1999/xhtml">
       
     3 <head>
       
     4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
       
     5 <title>TB9.2 Example Applications: CDeviceDiscoverer Class Reference</title>
       
     6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
       
     7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
       
     8 </head>
       
     9 <body>
       
    10 <!-- Generated by Doxygen 1.6.2 -->
       
    11 <div class="contents">
       
    12 <h1>CDeviceDiscoverer Class Reference</h1><!-- doxytag: class="CDeviceDiscoverer" -->
       
    13 <p><a href="class_c_device_discoverer-members.html">List of all members.</a></p>
       
    14 <table border="0" cellpadding="0" cellspacing="0">
       
    15 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
       
    16 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#a338c70f66e1dedaa7ce4ad694168aa93">~CDeviceDiscoverer</a> ()</td></tr>
       
    17 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#ac48267243d969875fb2b313ff77dbdc6">DiscoverDevicesL</a> (TDeviceDataList *aDevDataList)</td></tr>
       
    18 <tr><td class="memItemLeft" align="right" valign="top">TBool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#a53754a551f4ba92b473cfaa08143d73c">HasDevices</a> ()</td></tr>
       
    19 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#aba19673b682f694b38b5e58ddecaf2b6">StopDiscovery</a> ()</td></tr>
       
    20 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
       
    21 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#a398f58248e421a888c463adcc53dc321">NewL</a> (RSocketServ &amp;aSocketServ, <a class="el" href="class_m_device_disco_observer.html">MDeviceDiscoObserver</a> &amp;aObserver)</td></tr>
       
    22 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#ad009466530d86638c239aebab062d0b5">NewLC</a> (RSocketServ &amp;aSocketServ, <a class="el" href="class_m_device_disco_observer.html">MDeviceDiscoObserver</a> &amp;aObserver)</td></tr>
       
    23 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
       
    24 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#a827525f4196483e7648fa0941b04c401">RunL</a> ()</td></tr>
       
    25 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_device_discoverer.html#a55bb42dd0eeea3054482d55cbfb61332">DoCancel</a> ()</td></tr>
       
    26 </table>
       
    27 <hr/><a name="_details"></a><h2>Detailed Description</h2>
       
    28 
       
    29 <p>Definition at line <a class="el" href="_device_discoverer_8h_source.html#l00041">41</a> of file <a class="el" href="_device_discoverer_8h_source.html">DeviceDiscoverer.h</a>.</p>
       
    30 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
       
    31 <a class="anchor" id="a338c70f66e1dedaa7ce4ad694168aa93"></a><!-- doxytag: member="CDeviceDiscoverer::~CDeviceDiscoverer" ref="a338c70f66e1dedaa7ce4ad694168aa93" args="()" -->
       
    32 <div class="memitem">
       
    33 <div class="memproto">
       
    34       <table class="memname">
       
    35         <tr>
       
    36           <td class="memname">CDeviceDiscoverer::~CDeviceDiscoverer </td>
       
    37           <td>(</td>
       
    38           <td class="paramname"></td>
       
    39           <td>&nbsp;)&nbsp;</td>
       
    40           <td></td>
       
    41         </tr>
       
    42       </table>
       
    43 </div>
       
    44 <div class="memdoc">
       
    45 <p><a class="el" href="class_c_device_discoverer.html#a338c70f66e1dedaa7ce4ad694168aa93">~CDeviceDiscoverer()</a></p>
       
    46 <p>discussion Destroy the object and release all memory objects </p>
       
    47 
       
    48 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00056">56</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
    49 
       
    50 </div>
       
    51 </div>
       
    52 <hr/><h2>Member Function Documentation</h2>
       
    53 <a class="anchor" id="a398f58248e421a888c463adcc53dc321"></a><!-- doxytag: member="CDeviceDiscoverer::NewL" ref="a398f58248e421a888c463adcc53dc321" args="(RSocketServ &amp;aSocketServ, MDeviceDiscoObserver &amp;aObserver)" -->
       
    54 <div class="memitem">
       
    55 <div class="memproto">
       
    56       <table class="memname">
       
    57         <tr>
       
    58           <td class="memname"><a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> * CDeviceDiscoverer::NewL </td>
       
    59           <td>(</td>
       
    60           <td class="paramtype">RSocketServ &amp;&nbsp;</td>
       
    61           <td class="paramname"> <em>aSocketServ</em>, </td>
       
    62         </tr>
       
    63         <tr>
       
    64           <td class="paramkey"></td>
       
    65           <td></td>
       
    66           <td class="paramtype"><a class="el" href="class_m_device_disco_observer.html">MDeviceDiscoObserver</a> &amp;&nbsp;</td>
       
    67           <td class="paramname"> <em>aObserver</em></td><td>&nbsp;</td>
       
    68         </tr>
       
    69         <tr>
       
    70           <td></td>
       
    71           <td>)</td>
       
    72           <td></td><td></td><td><code> [static]</code></td>
       
    73         </tr>
       
    74       </table>
       
    75 </div>
       
    76 <div class="memdoc">
       
    77 <p><a class="el" href="class_c_device_discoverer.html#a398f58248e421a888c463adcc53dc321">NewL()</a></p>
       
    78 <p>discussion Create new <a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> object return a pointer to the created instance of <a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> </p>
       
    79 
       
    80 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00010">10</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
    81 
       
    82 </div>
       
    83 </div>
       
    84 <a class="anchor" id="ad009466530d86638c239aebab062d0b5"></a><!-- doxytag: member="CDeviceDiscoverer::NewLC" ref="ad009466530d86638c239aebab062d0b5" args="(RSocketServ &amp;aSocketServ, MDeviceDiscoObserver &amp;aObserver)" -->
       
    85 <div class="memitem">
       
    86 <div class="memproto">
       
    87       <table class="memname">
       
    88         <tr>
       
    89           <td class="memname"><a class="el" href="class_c_device_discoverer.html">CDeviceDiscoverer</a> * CDeviceDiscoverer::NewLC </td>
       
    90           <td>(</td>
       
    91           <td class="paramtype">RSocketServ &amp;&nbsp;</td>
       
    92           <td class="paramname"> <em>aSocketServ</em>, </td>
       
    93         </tr>
       
    94         <tr>
       
    95           <td class="paramkey"></td>
       
    96           <td></td>
       
    97           <td class="paramtype"><a class="el" href="class_m_device_disco_observer.html">MDeviceDiscoObserver</a> &amp;&nbsp;</td>
       
    98           <td class="paramname"> <em>aObserver</em></td><td>&nbsp;</td>
       
    99         </tr>
       
   100         <tr>
       
   101           <td></td>
       
   102           <td>)</td>
       
   103           <td></td><td></td><td><code> [static]</code></td>
       
   104         </tr>
       
   105       </table>
       
   106 </div>
       
   107 <div class="memdoc">
       
   108 <p><a class="el" href="class_c_device_discoverer.html#ad009466530d86638c239aebab062d0b5">NewLC()</a> </p>
       
   109 
       
   110 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00019">19</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   111 
       
   112 </div>
       
   113 </div>
       
   114 <a class="anchor" id="ac48267243d969875fb2b313ff77dbdc6"></a><!-- doxytag: member="CDeviceDiscoverer::DiscoverDevicesL" ref="ac48267243d969875fb2b313ff77dbdc6" args="(TDeviceDataList *aDevDataList)" -->
       
   115 <div class="memitem">
       
   116 <div class="memproto">
       
   117       <table class="memname">
       
   118         <tr>
       
   119           <td class="memname">void CDeviceDiscoverer::DiscoverDevicesL </td>
       
   120           <td>(</td>
       
   121           <td class="paramtype">TDeviceDataList *&nbsp;</td>
       
   122           <td class="paramname"> <em>aDevDataList</em></td>
       
   123           <td>&nbsp;)&nbsp;</td>
       
   124           <td></td>
       
   125         </tr>
       
   126       </table>
       
   127 </div>
       
   128 <div class="memdoc">
       
   129 <p><a class="el" href="class_c_device_discoverer.html#ac48267243d969875fb2b313ff77dbdc6">DiscoverDevicesL()</a></p>
       
   130 <p>discussion Discovers remote bluetooth devices within range.</p>
       
   131 <p>param aDevDataList device data list where the found devices will be placed. </p>
       
   132 
       
   133 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00070">70</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   134 
       
   135 </div>
       
   136 </div>
       
   137 <a class="anchor" id="a53754a551f4ba92b473cfaa08143d73c"></a><!-- doxytag: member="CDeviceDiscoverer::HasDevices" ref="a53754a551f4ba92b473cfaa08143d73c" args="()" -->
       
   138 <div class="memitem">
       
   139 <div class="memproto">
       
   140       <table class="memname">
       
   141         <tr>
       
   142           <td class="memname">TBool CDeviceDiscoverer::HasDevices </td>
       
   143           <td>(</td>
       
   144           <td class="paramname"></td>
       
   145           <td>&nbsp;)&nbsp;</td>
       
   146           <td></td>
       
   147         </tr>
       
   148       </table>
       
   149 </div>
       
   150 <div class="memdoc">
       
   151 <p><a class="el" href="class_c_device_discoverer.html#a53754a551f4ba92b473cfaa08143d73c">HasDevices()</a></p>
       
   152 <p>discussion any devices discovered?</p>
       
   153 <p>return true if any devices were discovered. </p>
       
   154 
       
   155 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00151">151</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   156 
       
   157 </div>
       
   158 </div>
       
   159 <a class="anchor" id="aba19673b682f694b38b5e58ddecaf2b6"></a><!-- doxytag: member="CDeviceDiscoverer::StopDiscovery" ref="aba19673b682f694b38b5e58ddecaf2b6" args="()" -->
       
   160 <div class="memitem">
       
   161 <div class="memproto">
       
   162       <table class="memname">
       
   163         <tr>
       
   164           <td class="memname">void CDeviceDiscoverer::StopDiscovery </td>
       
   165           <td>(</td>
       
   166           <td class="paramname"></td>
       
   167           <td>&nbsp;)&nbsp;</td>
       
   168           <td></td>
       
   169         </tr>
       
   170       </table>
       
   171 </div>
       
   172 <div class="memdoc">
       
   173 <p><a class="el" href="class_c_device_discoverer.html#aba19673b682f694b38b5e58ddecaf2b6">StopDiscovery()</a></p>
       
   174 <p>discussion Stops ongoing device discovery </p>
       
   175 
       
   176 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00178">178</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   177 
       
   178 </div>
       
   179 </div>
       
   180 <a class="anchor" id="a827525f4196483e7648fa0941b04c401"></a><!-- doxytag: member="CDeviceDiscoverer::RunL" ref="a827525f4196483e7648fa0941b04c401" args="()" -->
       
   181 <div class="memitem">
       
   182 <div class="memproto">
       
   183       <table class="memname">
       
   184         <tr>
       
   185           <td class="memname">void CDeviceDiscoverer::RunL </td>
       
   186           <td>(</td>
       
   187           <td class="paramname"></td>
       
   188           <td>&nbsp;)&nbsp;</td>
       
   189           <td><code> [protected]</code></td>
       
   190         </tr>
       
   191       </table>
       
   192 </div>
       
   193 <div class="memdoc">
       
   194 <p><a class="el" href="class_c_device_discoverer.html#a827525f4196483e7648fa0941b04c401">RunL()</a></p>
       
   195 <p>discussion Handle the active objects request completion. </p>
       
   196 
       
   197 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00106">106</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   198 
       
   199 </div>
       
   200 </div>
       
   201 <a class="anchor" id="a55bb42dd0eeea3054482d55cbfb61332"></a><!-- doxytag: member="CDeviceDiscoverer::DoCancel" ref="a55bb42dd0eeea3054482d55cbfb61332" args="()" -->
       
   202 <div class="memitem">
       
   203 <div class="memproto">
       
   204       <table class="memname">
       
   205         <tr>
       
   206           <td class="memname">void CDeviceDiscoverer::DoCancel </td>
       
   207           <td>(</td>
       
   208           <td class="paramname"></td>
       
   209           <td>&nbsp;)&nbsp;</td>
       
   210           <td><code> [protected]</code></td>
       
   211         </tr>
       
   212       </table>
       
   213 </div>
       
   214 <div class="memdoc">
       
   215 <p><a class="el" href="class_c_device_discoverer.html#a55bb42dd0eeea3054482d55cbfb61332">DoCancel()</a></p>
       
   216 <p>discussion Cancels the outstanding request on active object. </p>
       
   217 
       
   218 <p>Definition at line <a class="el" href="_device_discoverer_8cpp_source.html#l00141">141</a> of file <a class="el" href="_device_discoverer_8cpp_source.html">DeviceDiscoverer.cpp</a>.</p>
       
   219 
       
   220 </div>
       
   221 </div>
       
   222 </div>
       
   223 <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
       
   224 <a href="http://www.doxygen.org/index.html">
       
   225 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
       
   226 </body>
       
   227 </html>