diff -r 89d6a7a84779 -r 25a17d01db0c Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_pan_connections.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_pan_connections.html Fri Jan 22 18:26:19 2010 +0000 @@ -0,0 +1,677 @@ + + +TB10.1 Example Applications: CPanConnections Class Reference + + + + +

CPanConnections Class Reference

+

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 ~CPanConnections ()
+void CancelRecvFrom ()
TInt StartConnection (TBTDevAddr *aDevAddr, TBool aUsePANNotifier, TBool aUseTcpTransport)
TInt StopConnection ()
TInt SetActivePanConn (TUint aConnIndex)
void SetLocalIpAddrL (TUint32 aAddr)
void SetFixedRoleL (TSide aSide, TUint aRole)
void PrintConns ()
TInt TcpIpBindAndListen ()
TInt TcpIpBindAndConnect ()
void ListenDoCancel ()
void ConnectDoCancel ()
TInt CloseTcpIpSocketConnect ()
TUint32 GetRemoteIpAddr () const
void SetRemoteIpAddr (TUint32 aAddr)
TInt AcceptNewSocket ()
void PrintTcpSocketConnections ()
TInt GetLocalRole () const
void CancelIap ()
TInt StopIAP ()
TInt CloseAllTcpIpSockets ()
TInt CloseCurrentTcpIpSocket ()
TInt ActiveConnCount ()
+void CancelAllOperations ()
+TInt UdpBind ()
void RunL ()
void DoCancel ()
RArray< TInetAddr > & RemoteNames ()
+RSocket & GetSocket ()
+RArray< RSocket > & GetSocketArray ()

Static Public Member Functions

static CPanConnectionsNewL (CConsoleBase &aConsole)

Public Attributes

+TBool iIapStarted
+TBool iIapLoading
+TBool iListening
+


Detailed Description

+The CPanConnections 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). +

Definition at line 56 of file panconnection.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CPanConnections::~CPanConnections (  ) 
+
+
+ +

+Destruction. +

Definition at line 59 of file panconnection.cpp.

+ +
+

+


Member Function Documentation

+ +
+
+ + + + + + + + + +
CPanConnections * CPanConnections::NewL (CConsoleBase &  aConsole  )  [static]
+
+
+ +

+CPanConnections NewL function +

Definition at line 37 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
TInt CPanConnections::StartConnection (TBTDevAddr *  aDevAddr,
TBool  aUsePANNotifier,
TBool  aUseTcpTransport 
)
+
+
+ +

+Function called to Start a connection (IAP). +

Definition at line 321 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::StopConnection (  ) 
+
+
+ +

+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. +

Definition at line 652 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
TInt CPanConnections::SetActivePanConn (TUint  aConnIndex  ) 
+
+
+ +

+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. +

Definition at line 682 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void CPanConnections::SetLocalIpAddrL (TUint32  addr  ) 
+
+
+ +

+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. +

Definition at line 487 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void CPanConnections::SetFixedRoleL (TSide  aSide,
TUint  aRole 
)
+
+
+ +

+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). +

Definition at line 530 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::PrintConns (  ) 
+
+
+ +

+Function to print the current connections we have. +

Definition at line 731 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::TcpIpBindAndListen (  ) 
+
+
+ +

+Function that will bind and listen on a socket +

Definition at line 960 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::TcpIpBindAndConnect (  ) 
+
+
+ +

+Function used to bind and connect to an existing socket. The socket we connect to has to be ready to Accept us. +

Definition at line 926 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::ListenDoCancel (  ) 
+
+
+ +

+Function called if the current accept on a socket is canceled before completing. +

Definition at line 870 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::ConnectDoCancel (  ) 
+
+
+ +

+Function that is called to cancel an outstanding socket connection +

Definition at line 821 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::CloseTcpIpSocketConnect (  ) 
+
+
+ +

+Function to shutdown the existing socket. +

Definition at line 1043 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TUint32 CPanConnections::GetRemoteIpAddr (  )  const
+
+
+ +

+Function to recall the remote IP address we have set. +

Definition at line 889 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void CPanConnections::SetRemoteIpAddr (TUint32  aAddr  ) 
+
+
+ +

+Take the address entered and set it as our remote IP address (the device we wish to connect to). +

Definition at line 881 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::AcceptNewSocket (  ) 
+
+
+ +

+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. +

Definition at line 990 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::PrintTcpSocketConnections (  ) 
+
+
+ +

+Function that prints out the IP addresses of the connected devices. +

Definition at line 1084 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::GetLocalRole (  )  const
+
+
+ +

+Get the local role +

Definition at line 1116 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::CancelIap (  ) 
+
+
+ +

+Function called is an outstanding connection request is canceled. +

Definition at line 640 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::StopIAP (  ) 
+
+
+ +

+Function to stop the connection to the IAP. +

Definition at line 613 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::CloseAllTcpIpSockets (  ) 
+
+
+ +

+Function to shutdown all sockets in the socket array. This function only applies to a PAN-Gn. +

Definition at line 1057 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::CloseCurrentTcpIpSocket (  ) 
+
+
+ +

+Function to Shutdown a socket of the users choice. +

Definition at line 1072 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CPanConnections::ActiveConnCount (  ) 
+
+
+ +

+Function that return the number of active connections. +

Definition at line 1126 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::RunL (  ) 
+
+
+ +

+When the IAP connection has connected asyncronously our RunL will be called. +

Definition at line 268 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CPanConnections::DoCancel (  ) 
+
+
+ +

+If the request to start a new connection is cancelled before completion this function will be called. +

Definition at line 310 of file panconnection.cpp.

+ +
+

+ +

+
+ + + + + + + + +
RArray< TInetAddr > & CPanConnections::RemoteNames (  ) 
+
+
+ +

+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 +

Definition at line 831 of file panconnection.cpp.

+ +
+

+


Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by  + +doxygen 1.5.3
+ +