Symbian3/SDK/Source/GUID-5CFC075C-8F53-5E1B-A111-C6F4567DFD1E.dita
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Wed, 31 Mar 2010 11:11:55 +0100
changeset 7 51a74ef9ed63
permissions -rw-r--r--
Week 12 contribution of API Specs and fix SDK submission

<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License 
"Eclipse Public License v1.0" which accompanies this distribution, 
and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
<!-- Initial Contributors:
    Nokia Corporation - initial contribution.
Contributors: 
-->
<!DOCTYPE reference
  PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="GUID-5CFC075C-8F53-5E1B-A111-C6F4567DFD1E" xml:lang="en"><title>RConnection
API Summary Reference</title><shortdesc>This topic provides a summary of the functionality of the <codeph>RConnection</codeph> class. </shortdesc><prolog><metadata><keywords/></metadata></prolog><refbody>
<section id="GUID-C10393D8-182C-42FE-BA36-4CC0487ADB1E"><title>System wide connection management and monitoring</title> <p>Functions
that apply to all connections, not just the current one. </p> <ul>
<li id="GUID-E4DDDFD9-EAC6-5EB3-9B83-5CABA6390D45"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-18F9018F-78DE-3A7E-8363-B7CB101E7A99"><apiname>RConnection::EnumerateConnections(TUint&amp;)</apiname></xref>  </p> </li>
<li id="GUID-3BFF215D-DE03-53DC-ACCE-CB025568B968"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-EA525DAF-A097-373D-BC77-B55398BEE43A"><apiname>RConnection::AllInterfaceNotification(TDes8&amp;,
                TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-843B9547-4E1E-5FA8-B746-4CF749B8752B"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-73D1DAF7-2465-38FE-98BB-3E82EEE9EF4C"><apiname>RConnection::CancelAllInterfaceNotification()</apiname></xref>  </p> </li>
</ul> </section>
<section id="GUID-4EEF4B9B-6D0E-4FEB-8D91-60C1B40359BB"><title>Sub-Connection management and monitoring APIs in RConnection</title> <p>Retrieves
information on <xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita"><apiname>RSubConnection</apiname></xref> s and manages <xref href="GUID-0AFDA357-EE44-3788-9CAB-162B874134BF.dita"><apiname>RSubConnection</apiname></xref> s. </p> <ul>
<li id="GUID-8AA919BF-9A35-5C47-8B77-FF71BD6CD952"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-F71CF9AC-32FE-3B78-B6BC-8BEEA812EE3A"><apiname>RConnection::Stop(TSubConnectionUniqueId)</apiname></xref>  </p> </li>
<li id="GUID-F698091E-8627-548F-BB0C-548945423140"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-0C9A0D29-1A7D-3480-8546-72097D4E1AD8"><apiname>RConnection::Stop(TSubConnectionUniqueId,
                TConnStopType)</apiname></xref>  </p> </li>
<li id="GUID-9BBB5548-53E8-5BDE-BC07-D8E598152403"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-6E7005CF-4D8E-31CE-BAEA-21965ACC9C17"><apiname>RConnection::ProgressNotification(TSubConnectionUniqueId,
                TNifProgressBuf&amp;, TRequestStatus&amp;, TUint)</apiname></xref>  </p> </li>
<li id="GUID-8114BE60-F2E7-5320-9B0F-A23913CB3A00"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-890F2F7B-05D5-3A7B-8619-BFAD7345EFAF"><apiname>RConnection::CancelProgressNotification(TSubConnectionUniqueId)</apiname></xref> </p> </li>
<li id="GUID-E35EC22D-B7F1-53D4-9D61-33776A7B0FC3"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-F6F43C7C-10BE-3757-8D26-F35D50E801FC"><apiname>RConnection::Progress(TSubConnectionUniqueId,
                TNifProgress&amp;)</apiname></xref>  </p> </li>
<li id="GUID-555D90BD-5FDC-5A9D-A4CD-18BF44715FA3"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-D70F8B5D-2F5F-3DC6-BD80-1A0A16EFEA04"><apiname>RConnection::IsSubConnectionActiveRequest()</apiname></xref>  </p> </li>
<li id="GUID-FA96D097-6B75-5F5C-AC38-343592B2C863"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-2D5FA89C-1DC8-3DE7-8BC9-A2BE8631DC96"><apiname>RConnection::IsSubConnectionActiveCancel()</apiname></xref>  </p> </li>
</ul> </section>
<section id="GUID-76F61554-4154-4976-9B01-1AD4DEA71070"><title>Connection settings for RConnection</title> <p>Allows the
configuration settings for this connection to be retrieved from CommsDat. </p> <ul>
<li id="GUID-161BE780-A7D7-5D16-9441-8D0B5FEA0E8D"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-51194DA0-08E7-31B4-94B8-A2966C6E4E0D"><apiname>RConnection::GetIntSetting(const
TDesC&amp;,                 TUint32&amp;)</apiname></xref>  </p> </li>
<li id="GUID-82F697B3-DA93-54E9-92A5-21F56E4A0F98"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-DCDB6B57-0C99-3E46-92AA-B30D483E8428"><apiname>RConnection::GetBoolSetting(const
TDesC&amp;,                 TBool&amp;)</apiname></xref>  </p> </li>
<li id="GUID-3347F04F-AF72-5A0C-82BF-5C0222E825B3"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-DF16BCD4-D0D2-3F5B-8771-EFA8AD274E0F"><apiname>RConnection::GetDesSetting(const
TDesC&amp;,                 TDes8&amp;);</apiname></xref>  </p> </li>
<li id="GUID-224B7992-5EB8-55D1-B521-08292E198404"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-8E18A6F0-59C7-3508-B4B6-155F47E873C6"><apiname>RConnection::GetDesSetting(const
TDesC&amp;,                 TDes16&amp;);</apiname></xref>  </p> </li>
<li id="GUID-69B62E75-74B8-5F85-8365-928A7D98DEE1"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-14155E9D-7F32-3593-8A9F-5D0FBC48CDFD"><apiname>RConnection::GetLongDesSetting(const
TDesC&amp;                 aSettingName, TDes&amp; aValue)</apiname></xref>  </p> </li>
</ul> </section>
<section id="GUID-5E2A8B76-2DC9-431E-9A82-73E5456ECA70"><title>Data monitoring APIs in RConnection</title> <p>Gets statistics
on data throughput. </p> <ul>
<li id="GUID-9F88F4AF-5074-5B72-863E-587EC932AD5B"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-15E9E497-E4ED-30BE-9B52-57120E6C0281"><apiname>RConnection::DataTransferredRequest(TPckg&lt;TUint&gt;&amp;,
                TPckg&lt;TUint&gt;&amp;, TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-28A18C73-302C-5691-BB4C-BBBC8508FD3C"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-8387A088-BF9C-3ED8-ABAC-63AE910E14AC"><apiname>RConnection::DataTransferredRequest(TSubConnectionUniqueId,
                TPckg&lt;TUint&gt;&amp;, TPckg&lt;TUint&gt;&amp;,              
  TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-B0B564F3-9DB7-59F5-AB18-6567BA0EA996"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-6C3BA56C-90AC-39BD-8FBC-B6BB94D62F0E"><apiname>RConnection::DataTransferredCancel()</apiname></xref>  </p> </li>
<li id="GUID-04F01201-2830-5754-8979-A5C09DF7FF7D"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-76B4897E-0032-3F63-931D-B3DB2E38087C"><apiname>RConnection::DataTransferredCancel(TSubConnectionUniqueId)</apiname></xref> </p> </li>
<li id="GUID-3DBB8110-8594-5CBB-9371-C1D6D79D47E3"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-E85850A2-9A07-368A-8A0A-DC83E4A912AD"><apiname>RConnection::DataSentNotificationRequest(TUint,
                TPckg&lt;TUint&gt;&amp;, TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-8E889A7C-CD75-5980-85BF-558FFB01C869"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-F83EBDAB-74FE-337A-AA80-F01D1883F989"><apiname>RConnection::DataSentNotificationRequest(TSubConnectionUniqueId,
                TUint, TPckg&lt;TUint&gt;&amp;, TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-41234B4C-8257-5C9E-8CF9-743D2A191884"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-681E6ED5-D70E-3002-9799-6FB1091D2372"><apiname>RConnection::DataSentNotificationCancel()</apiname></xref>  </p> </li>
<li id="GUID-2EF66406-940E-5A65-A292-41128C0B1C66"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-2C0087A7-F25A-39A9-B78D-4B3A9FCBC054"><apiname>RConnection::DataSentNotificationCancel(TSubConnectionUniqueId)</apiname></xref> </p> </li>
<li id="GUID-E3A29434-8074-5E60-B6F3-BB1248540872"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-AFFDA421-7404-3808-905F-C0A2D4A44D36"><apiname>RConnection::
NotificationRequest(TUint,                 TPckg&lt;TUint&gt;&amp;, TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-75F5A8D4-6EB0-5346-8AE4-4F72128E6391"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-9E056551-22C2-3F85-8E3D-C11FA3B46F07"><apiname>RConnection::DataReceivedNotificationRequest(TSubConnectionUniqueId,
                TUint, TPckg&lt;TUint&gt;&amp;, TRequestStatus&amp;)</apiname></xref>  </p> </li>
<li id="GUID-6535CDDF-2E36-5628-9C48-C2526740534F"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-178479E8-6526-30D3-8744-A61EA55A53FA"><apiname>RConnection::DataReceivedNotificationCancel()</apiname></xref>  </p> </li>
<li id="GUID-81BF491F-EFD8-540A-8767-C789D65F6F40"><p> <xref href="GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD.dita#GUID-BED8A733-2ED7-31AD-A911-C1F4707C67FD/GUID-20B2E4E3-5A66-36B7-876F-87F147C1C1F6"><apiname>RConnection::DataReceivedNotificationCancel(TSubConnectionUniqueId)</apiname></xref> </p> </li>
</ul> </section>

<section id="GUID-4EF82317-EEE3-4976-90D1-B20D12B4D565"><title>See Also</title> <p> <xref href="GUID-12C9C36B-8AD4-544E-A6A3-54A799EF0280.dita">ESock
Reference</xref>  </p> </section>
</refbody></reference>