Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_service_advertiser.html
author Graeme Price <GRAEME.PRICE@NOKIA.COM>
Fri, 15 Oct 2010 14:32:18 +0100
changeset 15 307f4279f433
parent 6 43e37759235e
permissions -rw-r--r--
Initial contribution of the Adaptation Documentation.

<!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: CServiceAdvertiser 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>CServiceAdvertiser Class Reference</h1><!-- doxytag: class="CServiceAdvertiser" -->
<p><a href="class_c_service_advertiser-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_advertiser.html#a2f8c410fff06231459357dadf91c300b">~CServiceAdvertiser</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_advertiser.html#a472557c615ce3eb0a59f64bb1f6a0de1">StartAdvertiserL</a> (TInt)</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_advertiser.html#a7a05532cd0a9fb44ab40f1ffa1ff1c39">StopAdvertiserL</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_advertiser.html#ab1c8f92e638fed6da1718268407b05eb">UpdateAvailabilityL</a> (TBool)</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_advertiser.html">CServiceAdvertiser</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_advertiser.html#a806cb9d464c1416a6441a9aba38b203c">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_service_advertiser.html">CServiceAdvertiser</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_service_advertiser.html#ae9caf6f124248cc0e8f93e7263894ba7">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

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

<p>Definition at line <a class="el" href="_service_advertiser_8cpp_source.html#l00052">52</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a806cb9d464c1416a6441a9aba38b203c"></a><!-- doxytag: member="CServiceAdvertiser::NewL" ref="a806cb9d464c1416a6441a9aba38b203c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_service_advertiser.html">CServiceAdvertiser</a> * CServiceAdvertiser::NewL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_advertiser.html#a806cb9d464c1416a6441a9aba38b203c">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_advertiser_8cpp_source.html#l00015">15</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ae9caf6f124248cc0e8f93e7263894ba7"></a><!-- doxytag: member="CServiceAdvertiser::NewLC" ref="ae9caf6f124248cc0e8f93e7263894ba7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_c_service_advertiser.html">CServiceAdvertiser</a> * CServiceAdvertiser::NewLC </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_advertiser.html#ae9caf6f124248cc0e8f93e7263894ba7">NewLC()</a> </p>

<p>Definition at line <a class="el" href="_service_advertiser_8cpp_source.html#l00023">23</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a472557c615ce3eb0a59f64bb1f6a0de1"></a><!-- doxytag: member="CServiceAdvertiser::StartAdvertiserL" ref="a472557c615ce3eb0a59f64bb1f6a0de1" args="(TInt)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceAdvertiser::StartAdvertiserL </td>
          <td>(</td>
          <td class="paramtype">TInt&nbsp;</td>
          <td class="paramname"> <em>aChannel</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_advertiser.html#a472557c615ce3eb0a59f64bb1f6a0de1">StartAdvertiserL()</a></p>
<p>discussion Starts the service advertiser.</p>
<p>param aChannel the communication channel (port) the service will be advertised on. an entry for our advertisement will be added to service discovery database. </p>

<p>Definition at line <a class="el" href="_service_advertiser_8cpp_source.html#l00065">65</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a7a05532cd0a9fb44ab40f1ffa1ff1c39"></a><!-- doxytag: member="CServiceAdvertiser::StopAdvertiserL" ref="a7a05532cd0a9fb44ab40f1ffa1ff1c39" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceAdvertiser::StopAdvertiserL </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_advertiser.html#a7a05532cd0a9fb44ab40f1ffa1ff1c39">StopAdvertiserL()</a></p>
<p>discussion Stops the service advertiser. our entry from service discovery database will be removed. </p>

<p>Definition at line <a class="el" href="_service_advertiser_8cpp_source.html#l00124">124</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab1c8f92e638fed6da1718268407b05eb"></a><!-- doxytag: member="CServiceAdvertiser::UpdateAvailabilityL" ref="ab1c8f92e638fed6da1718268407b05eb" args="(TBool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CServiceAdvertiser::UpdateAvailabilityL </td>
          <td>(</td>
          <td class="paramtype">TBool&nbsp;</td>
          <td class="paramname"> <em>aAvailable</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_service_advertiser.html#ab1c8f92e638fed6da1718268407b05eb">UpdateAvailabilityL()</a></p>
<p>discussion Updates the availability of advertised service. the service record in service discovery database will be updated accordingly.</p>
<p>param aAvailable true if the service should be set as available, false if unavailable. </p>

<p>Definition at line <a class="el" href="_service_advertiser_8cpp_source.html#l00144">144</a> of file <a class="el" href="_service_advertiser_8cpp_source.html">ServiceAdvertiser.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>