Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_pan_connections.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CPanConnections Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CPanConnections Class Reference</h1><!-- doxytag: class="CPanConnections" -->
<p>
<a href="class_c_pan_connections-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#6f1e2360d9b792b4eb67233dd0757d41">~CPanConnections</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38e615144ac8636db223dfab4d84dedb"></a><!-- doxytag: member="CPanConnections::CancelRecvFrom" ref="38e615144ac8636db223dfab4d84dedb" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#38e615144ac8636db223dfab4d84dedb">CancelRecvFrom</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#34c21dab326042522928cc4796c92df2">StartConnection</a> (TBTDevAddr *aDevAddr, TBool aUsePANNotifier, TBool aUseTcpTransport)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#6ca7760ec4140c02725dc8a29c061ba9">StopConnection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#0eec65826c0323a9ab6e85b0739bbc44">SetActivePanConn</a> (TUint aConnIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#c3da88ca7fc0fb64434fd84f81cddc98">SetLocalIpAddrL</a> (TUint32 aAddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#46d8bac828d453473cec94a8602468ac">SetFixedRoleL</a> (TSide aSide, TUint aRole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#0ce9d37dc00e0572bb5c7f0b5befa07b">PrintConns</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#0cab5de7e4afe736c2469735640ec1ba">TcpIpBindAndListen</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#acbdae817598b72658b6b93833ee0975">TcpIpBindAndConnect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#514cfbe2ba7d674954dbc60c85ab7018">ListenDoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#070d37e1361be12f2dc44fee0653597b">ConnectDoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#1c722de1ae920eb3160284c18c6bed99">CloseTcpIpSocketConnect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TUint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#1f0cd7f4bcfd821937b31c7daaf9af62">GetRemoteIpAddr</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#99afb06bc3e1614ec86be77da414e054">SetRemoteIpAddr</a> (TUint32 aAddr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#2487d17afe967008336124ab48a744ff">AcceptNewSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#f50cb29f97f35de684d03bf5211671f2">PrintTcpSocketConnections</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#f113f2b06e495b97ab788e3f0030b617">GetLocalRole</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#f442c51cea29f54570235995428a7bcb">CancelIap</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#526bf1de502ce10fcd0630e39aabc52e">StopIAP</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#36b2c2c4943f29420aa4ee6208e7c266">CloseAllTcpIpSockets</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#28a3b8b1bc3dcd590e6899e8ac08ce53">CloseCurrentTcpIpSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#6c2066f03c9d53e73206cff1dae7aa5b">ActiveConnCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe4f439df6bed9bce936292e6b87d098"></a><!-- doxytag: member="CPanConnections::CancelAllOperations" ref="fe4f439df6bed9bce936292e6b87d098" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#fe4f439df6bed9bce936292e6b87d098">CancelAllOperations</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f957a9c996254f7d243f3157497e3a8"></a><!-- doxytag: member="CPanConnections::UdpBind" ref="1f957a9c996254f7d243f3157497e3a8" args="()" -->
TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#1f957a9c996254f7d243f3157497e3a8">UdpBind</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#d3dc3627a7c944f0ffa82caa9f024166">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#2451289abf1a401dc5d343afa4eeaf86">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RArray< TInetAddr > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#bb1b1dc6e61cc3a4860e5480b2bd6c37">RemoteNames</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d82cc28dec893b9513dfac3b3f047c0"></a><!-- doxytag: member="CPanConnections::GetSocket" ref="9d82cc28dec893b9513dfac3b3f047c0" args="()" -->
RSocket & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#9d82cc28dec893b9513dfac3b3f047c0">GetSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71cac88a9f4c5b7338f0a9124bf44926"></a><!-- doxytag: member="CPanConnections::GetSocketArray" ref="71cac88a9f4c5b7338f0a9124bf44926" args="()" -->
RArray< RSocket > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#71cac88a9f4c5b7338f0a9124bf44926">GetSocketArray</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_pan_connections.html">CPanConnections</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#b3d65eba7c9b59bc2bf952a7e881a626">NewL</a> (CConsoleBase &aConsole)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="418dc0f90e99ec9637d9c1831044af04"></a><!-- doxytag: member="CPanConnections::iIapStarted" ref="418dc0f90e99ec9637d9c1831044af04" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#418dc0f90e99ec9637d9c1831044af04">iIapStarted</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16aec88b4b1dc3032457bb71b4534b5d"></a><!-- doxytag: member="CPanConnections::iIapLoading" ref="16aec88b4b1dc3032457bb71b4534b5d" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#16aec88b4b1dc3032457bb71b4534b5d">iIapLoading</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08eeb95689dc6653b48bf55b9cd14381"></a><!-- doxytag: member="CPanConnections::iListening" ref="08eeb95689dc6653b48bf55b9cd14381" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pan_connections.html#08eeb95689dc6653b48bf55b9cd14381">iListening</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="class_c_pan_connections.html">CPanConnections</a> class is responsible for setting up the underlying PAN. It's duties are to update the CommDb and use it to start an IAP, it allows for devices to be connected together in a network using Bluetooth. If the user wishes to be the dealer in the game (PAN-Gn) then they will be required to select the player (via Bluetooth address).
<p>Definition at line <a class="el" href="panconnection_8h-source.html#l00056">56</a> of file <a class="el" href="panconnection_8h-source.html">panconnection.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6f1e2360d9b792b4eb67233dd0757d41"></a><!-- doxytag: member="CPanConnections::~CPanConnections" ref="6f1e2360d9b792b4eb67233dd0757d41" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPanConnections::~CPanConnections </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destruction.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00059">59</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b3d65eba7c9b59bc2bf952a7e881a626"></a><!-- doxytag: member="CPanConnections::NewL" ref="b3d65eba7c9b59bc2bf952a7e881a626" args="(CConsoleBase &aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_pan_connections.html">CPanConnections</a> * CPanConnections::NewL </td>
<td>(</td>
<td class="paramtype">CConsoleBase & </td>
<td class="paramname"> <em>aConsole</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="class_c_pan_connections.html">CPanConnections</a> NewL function
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00037">37</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="34c21dab326042522928cc4796c92df2"></a><!-- doxytag: member="CPanConnections::StartConnection" ref="34c21dab326042522928cc4796c92df2" args="(TBTDevAddr *aDevAddr, TBool aUsePANNotifier, TBool aUseTcpTransport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::StartConnection </td>
<td>(</td>
<td class="paramtype">TBTDevAddr * </td>
<td class="paramname"> <em>aDevAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aUsePANNotifier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBool </td>
<td class="paramname"> <em>aUseTcpTransport</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function called to Start a connection (IAP).
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00321">321</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6ca7760ec4140c02725dc8a29c061ba9"></a><!-- doxytag: member="CPanConnections::StopConnection" ref="6ca7760ec4140c02725dc8a29c061ba9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::StopConnection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stops the currently active connection, this is the connection that the user has selected from the numeric menu option, therefore only one device will be disconnected at a time.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00652">652</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0eec65826c0323a9ab6e85b0739bbc44"></a><!-- doxytag: member="CPanConnections::SetActivePanConn" ref="0eec65826c0323a9ab6e85b0739bbc44" args="(TUint aConnIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::SetActivePanConn </td>
<td>(</td>
<td class="paramtype">TUint </td>
<td class="paramname"> <em>aConnIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that is passed the numeric option selected by the user, the iActivePanConn member is set so that we can perform tasks with this device, i.e. diconnect from RConnection.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00682">682</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c3da88ca7fc0fb64434fd84f81cddc98"></a><!-- doxytag: member="CPanConnections::SetLocalIpAddrL" ref="c3da88ca7fc0fb64434fd84f81cddc98" args="(TUint32 aAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::SetLocalIpAddrL </td>
<td>(</td>
<td class="paramtype">TUint32 </td>
<td class="paramname"> <em>addr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that takes an IP address from user input, accesses the Bluetooth PAN Profile table in the CommDb and updates the IpAddr field with the supplied address.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00487">487</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="46d8bac828d453473cec94a8602468ac"></a><!-- doxytag: member="CPanConnections::SetFixedRoleL" ref="46d8bac828d453473cec94a8602468ac" args="(TSide aSide, TUint aRole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::SetFixedRoleL </td>
<td>(</td>
<td class="paramtype">TSide </td>
<td class="paramname"> <em>aSide</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TUint </td>
<td class="paramname"> <em>aRole</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that accesses the PAN Service table in the CommDb and applies the appropriate role, this function will be used for local or peer as well as the PAN role (U or Gn).
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00530">530</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ce9d37dc00e0572bb5c7f0b5befa07b"></a><!-- doxytag: member="CPanConnections::PrintConns" ref="0ce9d37dc00e0572bb5c7f0b5befa07b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::PrintConns </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to print the current connections we have.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00731">731</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0cab5de7e4afe736c2469735640ec1ba"></a><!-- doxytag: member="CPanConnections::TcpIpBindAndListen" ref="0cab5de7e4afe736c2469735640ec1ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::TcpIpBindAndListen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that will bind and listen on a socket
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00960">960</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="acbdae817598b72658b6b93833ee0975"></a><!-- doxytag: member="CPanConnections::TcpIpBindAndConnect" ref="acbdae817598b72658b6b93833ee0975" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::TcpIpBindAndConnect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function used to bind and connect to an existing socket. The socket we connect to has to be ready to Accept us.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00926">926</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="514cfbe2ba7d674954dbc60c85ab7018"></a><!-- doxytag: member="CPanConnections::ListenDoCancel" ref="514cfbe2ba7d674954dbc60c85ab7018" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::ListenDoCancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function called if the current accept on a socket is canceled before completing.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00870">870</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="070d37e1361be12f2dc44fee0653597b"></a><!-- doxytag: member="CPanConnections::ConnectDoCancel" ref="070d37e1361be12f2dc44fee0653597b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::ConnectDoCancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that is called to cancel an outstanding socket connection
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00821">821</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1c722de1ae920eb3160284c18c6bed99"></a><!-- doxytag: member="CPanConnections::CloseTcpIpSocketConnect" ref="1c722de1ae920eb3160284c18c6bed99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::CloseTcpIpSocketConnect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to shutdown the existing socket.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01043">1043</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1f0cd7f4bcfd821937b31c7daaf9af62"></a><!-- doxytag: member="CPanConnections::GetRemoteIpAddr" ref="1f0cd7f4bcfd821937b31c7daaf9af62" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TUint32 CPanConnections::GetRemoteIpAddr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to recall the remote IP address we have set.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00889">889</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="99afb06bc3e1614ec86be77da414e054"></a><!-- doxytag: member="CPanConnections::SetRemoteIpAddr" ref="99afb06bc3e1614ec86be77da414e054" args="(TUint32 aAddr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::SetRemoteIpAddr </td>
<td>(</td>
<td class="paramtype">TUint32 </td>
<td class="paramname"> <em>aAddr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Take the address entered and set it as our remote IP address (the device we wish to connect to).
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00881">881</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2487d17afe967008336124ab48a744ff"></a><!-- doxytag: member="CPanConnections::AcceptNewSocket" ref="2487d17afe967008336124ab48a744ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::AcceptNewSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that creates a new blank socket, when a socket is connected the original socket will hand over control to the once blank socket. The new sockets will be held in an array. Once all sockets have connected we can proceed to send out the player numbers each player.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00990">990</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f50cb29f97f35de684d03bf5211671f2"></a><!-- doxytag: member="CPanConnections::PrintTcpSocketConnections" ref="f50cb29f97f35de684d03bf5211671f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::PrintTcpSocketConnections </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that prints out the IP addresses of the connected devices.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01084">1084</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f113f2b06e495b97ab788e3f0030b617"></a><!-- doxytag: member="CPanConnections::GetLocalRole" ref="f113f2b06e495b97ab788e3f0030b617" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::GetLocalRole </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the local role
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01116">1116</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f442c51cea29f54570235995428a7bcb"></a><!-- doxytag: member="CPanConnections::CancelIap" ref="f442c51cea29f54570235995428a7bcb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::CancelIap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function called is an outstanding connection request is canceled.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00640">640</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="526bf1de502ce10fcd0630e39aabc52e"></a><!-- doxytag: member="CPanConnections::StopIAP" ref="526bf1de502ce10fcd0630e39aabc52e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::StopIAP </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to stop the connection to the IAP.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00613">613</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="36b2c2c4943f29420aa4ee6208e7c266"></a><!-- doxytag: member="CPanConnections::CloseAllTcpIpSockets" ref="36b2c2c4943f29420aa4ee6208e7c266" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::CloseAllTcpIpSockets </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to shutdown all sockets in the socket array. This function only applies to a PAN-Gn.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01057">1057</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="28a3b8b1bc3dcd590e6899e8ac08ce53"></a><!-- doxytag: member="CPanConnections::CloseCurrentTcpIpSocket" ref="28a3b8b1bc3dcd590e6899e8ac08ce53" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::CloseCurrentTcpIpSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function to Shutdown a socket of the users choice.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01072">1072</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6c2066f03c9d53e73206cff1dae7aa5b"></a><!-- doxytag: member="CPanConnections::ActiveConnCount" ref="6c2066f03c9d53e73206cff1dae7aa5b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CPanConnections::ActiveConnCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function that return the number of active connections.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l01126">1126</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="d3dc3627a7c944f0ffa82caa9f024166"></a><!-- doxytag: member="CPanConnections::RunL" ref="d3dc3627a7c944f0ffa82caa9f024166" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::RunL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When the IAP connection has connected asyncronously our RunL will be called.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00268">268</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2451289abf1a401dc5d343afa4eeaf86"></a><!-- doxytag: member="CPanConnections::DoCancel" ref="2451289abf1a401dc5d343afa4eeaf86" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPanConnections::DoCancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the request to start a new connection is cancelled before completion this function will be called.
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00310">310</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="bb1b1dc6e61cc3a4860e5480b2bd6c37"></a><!-- doxytag: member="CPanConnections::RemoteNames" ref="bb1b1dc6e61cc3a4860e5480b2bd6c37" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RArray< TInetAddr > & CPanConnections::RemoteNames </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is a function that will return the array device addresses. This can then be used along with a reference to the socket to use the PAN
<p>Definition at line <a class="el" href="panconnection_8cpp-source.html#l00831">831</a> of file <a class="el" href="panconnection_8cpp-source.html">panconnection.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>