Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/rconnection_8h_source.html
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: examples/DataComms/Rconnection/rconnection.h Source File</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 -->
<h1>examples/DataComms/Rconnection/rconnection.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#ifndef RCONNECTION_H</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define RCONNECTION_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <e32cons.h></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <in_sock.h></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#include <es_enum.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <commdbconnpref.h></span>
<a name="l00024"></a>00024
<a name="l00025"></a><a class="code" href="class_c_r_connection.html">00025</a> <span class="keyword">class </span><a class="code" href="class_c_r_connection.html">CRConnection</a> : <span class="keyword">public</span> CBase
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">public</span>:
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">//Constructor.</span>
<a name="l00030"></a>00030 <a class="code" href="class_c_r_connection.html#a84c7cc0c77e1848e2c7abceaf98f8aa6">CRConnection</a>(CConsoleBase* aConsole);
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">//Destructor.</span>
<a name="l00033"></a>00033 <a class="code" href="class_c_r_connection.html#ace777e34413be6f891d646dbe977bfcb">~CRConnection</a>();
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">//Opens a session to the socket server and opens a connection that monitors for interface notification.</span>
<a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#a19bc66bcf8022be01b9ebababe8e8026">StartESOCK</a>();
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">//Demonstrates various RConnection API methods using default Commdb settings.</span>
<a name="l00039"></a>00039 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#acdcd4da66841b804b318afb37e4b4c1c">DemoApiWithoutDbOverrideL</a>();
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">//Demonstrates various RConnection API methods using non-default Commdb settings.</span>
<a name="l00042"></a>00042 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#abcbc56a50819c7293323114ea940583e">DemoApiWithDbOverrideL</a>();
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">//Starts a connection then attaches another connection to the same interface.</span>
<a name="l00045"></a>00045 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#a9eeb4eb377993b2e4cc2c313c953bef1">AttachToExistingInterfaceL</a>();
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">//Opens and starts a connection using non-default Commdb settings.</span>
<a name="l00048"></a>00048 TInt <a class="code" href="class_c_r_connection.html#a92ae35c52534f3a5c2bff2d0cb3ebddd">ConnectWithDbOverrideL</a>();
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">//Opens and starts a connection using default Commdb settings.</span>
<a name="l00051"></a>00051 TInt <a class="code" href="class_c_r_connection.html#a9e18367074b7c5054957d262096067cd">ConnectWithoutDbOverrideL</a>();
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">//Requests notification of the connection's progress.</span>
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#a147d17095309f15cc007cf20271884ec">GetProgressNotification</a>();
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">//Prints progress information to the console.</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#ae9aa5ca6ef0e36b4b1cccd2ef7c85ef4">DisplayProgressinfo</a>(<span class="keyword">const</span> TNifProgress& aProgress);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">//Displays text describing the next phase of the example.</span>
<a name="l00060"></a>00060 <span class="keywordtype">void</span> DisplaySectionToDemo(<span class="keyword">const</span> TDesC& aText);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">//Prepares the socket for carrying out data transfer.</span>
<a name="l00063"></a>00063 TInt <a class="code" href="class_c_r_connection.html#a7cccd60b864d9fe658eae6dcf62d79de">PrepareSocket</a>();
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">//Sends UDP packets over a socket.</span>
<a name="l00066"></a>00066 TInt <a class="code" href="class_c_r_connection.html#a70b4e383cacd646e109d8819be8c2741">SendUdpData</a>(TUint aPayloadSize);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">//Receives UDP packets over a socket.</span>
<a name="l00069"></a>00069 TInt <a class="code" href="class_c_r_connection.html#a466713ba7cf7584e7c4ba025c26bddff">RecvUdpData</a>(TUint aPayloadSize);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">//Calls SendUdpData() and RecvUdpData().</span>
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#ad1e2063ee36acfb0434006b4fdbadbb6">DataSendAndReceive</a>(TUint aPayloadSize);
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">//Gets the amount of data that has been transferred by the entire connection.</span>
<a name="l00075"></a>00075 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#a152237406ecb9b91534c869b0fcc5c54">DataTransferredRequest</a>();
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">//Requests notification when a certain amount of data has been sent or received.</span>
<a name="l00078"></a>00078 <span class="keywordtype">void</span> <a class="code" href="class_c_r_connection.html#a06a6adfc62452ed190cc1d461cfa1961">DataTransferNotificationRequest</a>();
<a name="l00079"></a>00079
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">private</span>:
<a name="l00082"></a>00082 RConnection iConnection;
<a name="l00083"></a>00083 RSocket iSocket;
<a name="l00084"></a>00084 RSocketServ iSocketServ;
<a name="l00085"></a>00085 CConsoleBase* iConsole;
<a name="l00086"></a>00086 TInetAddr iDestAddr;
<a name="l00087"></a>00087 TInt iCurrentProgress;
<a name="l00088"></a>00088 RConnection iMonitor;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#endif //RCONNECTION_H</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>