CConnMonWlanNetwork Class Reference

Link against: ConnMon.lib

Capability Information

Required Capabilities

None

Exceptions

ReadDeviceData to call

IMPORT_C void GetIntAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, TInt& aValue, TRequestStatus& aStatus );

IMPORT_C TInt SetIntAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, const TInt aValue ) const;

with aAttribute set to KProtocolType.

NetworkServices and NetworkControl to call

IMPORT_C void GetBoolAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, TBool& aValue, TRequestStatus& aStatus );

IMPORT_C TInt SetBoolAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, const TBool aValue ) const;

with aAttribute KConnectionStop or KConnectionStopAll.

ReadDeviceData to call

IMPORT_C void GetStringAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, TDes& aValue, TRequestStatus& aStatus ) const;

IMPORT_C TInt SetStringAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, const TDes& aValue ) const;

with aAttribute set to KAccessPointName or KNetworkName.

ReadUserData to call

IMPORT_C void GetStringAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, TDes& aValue, TRequestStatus& aStatus ) const;

IMPORT_C TInt SetStringAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, const TDes& aValue ) const;

with aAttribute set to KTelNumber.

NetworkControl to call

IMPORT_C void GetPckgAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, TDes8& aValue, TRequestStatus& aStatus ) const;

IMPORT_C TInt SetPckgAttribute( const TUint aConnectionId, const TUint aSubConnectionId, const TUint aAttribute, const TDes8& aValue ) const;

with aAttribute set to KClientInfo.


#include <
rconnmon.h>

Detailed Description

Class to represent a WLAN.

Used when reporting WLAN scan results back to a client.

Since:
S60 3.2

Public Member Functions

IMPORT_C ~CConnMonWlanNetwork ()
 Destructor.
IMPORT_C CConnMonWlanNetworkoperator= (CConnMonWlanNetwork &aConnMonWlanNetwork)
 Assignment operator.
TBuf< KMaxNameLengthName ()
 Obtains the name (SSID) of the network.
TUint ConnectionMode ()
 Obtains the connection mode of the network.
TUint SignalStrength ()
 Obtains the signal strength of the network.
TUint SecurityMode ()
 Obtains the security mode of the network.
TBuf8< KWlanBssIdWlanBssid ()
 Obtains the mac address (BSSID) of the base station.
HBufC * VendorData ()
 Obtaina a pointer to vendor specific data buffer.
const HBufC * ToBuf () const
 Writes object of class CConnMonWlanNetwork to memory.

Static Public Member Functions

static IMPORT_C CConnMonWlanNetworkNewL (const TBuf< KMaxNameLength > &aName, TUint aConnectionMode, TUint aSignalStrength, TUint aSecurityMode, const TBuf8< KWlanBssId > &aBssId, const TDesC &aVendorData)
 Constructor.
static IMPORT_C CConnMonWlanNetworkNewL ()
 Constructor.
static IMPORT_C CConnMonWlanNetworkNewL (CConnMonWlanNetwork &aConnMonWlanNetwork)
 Copy constructor.
static IMPORT_C TInt CompareBySignal (const CConnMonWlanNetwork &aFirst, const CConnMonWlanNetwork &aSecond)
 Compares two networks by signal strength.
static TInt FromPtrC (const TPtrC &aPtrC, CConnMonWlanNetwork *aConnMonWlanNetwork)
 Reads object of class CConnMonWlanNetwork from memory.

Static Public Attributes

static const TUint KMaxNameLength = 32
 Maximum length of a WLAN name (SSID).
static const TUint KWlanBssId = 6
 WLAN BSSID length (mac address).
static const TUint KExtraCount = 10
 Reserved for future use.

Constructor & Destructor Documentation

IMPORT_C CConnMonWlanNetwork::~CConnMonWlanNetwork  ) 
 

Destructor.

Since:
S60 3.2

Member Function Documentation

static IMPORT_C TInt CConnMonWlanNetwork::CompareBySignal const CConnMonWlanNetwork aFirst,
const CConnMonWlanNetwork aSecond
[static]
 

Compares two networks by signal strength.

Since:
S60 3.2
Parameters:
aFirst Reference to first WLAN object.
aSecond Reference to second WLAN object.
Returns:
Result of the comparison, 1 if first is less than second, 0 if they are equal and -1 otherwise.
TUint CConnMonWlanNetwork::ConnectionMode  )  [inline]
 

Obtains the connection mode of the network.

Since:
S60 3.2
Returns:
Connection mode (defined in TConnMonNetworkMode).
static TInt CConnMonWlanNetwork::FromPtrC const TPtrC &  aPtrC,
CConnMonWlanNetwork aConnMonWlanNetwork
[static]
 

Reads object of class CConnMonWlanNetwork from memory.

Since:
S60 3.2
Parameters:
aPtrC Pointer to the beginning of the CConnMonWlanNetwork object in buffer.
aConnMonWlanNetwork Pointer to CConnMonWlanNetwork object where unpacked contents are written.
Returns:
A Symbian OS error code.
TBuf<KMaxNameLength> CConnMonWlanNetwork::Name  )  [inline]
 

Obtains the name (SSID) of the network.

Since:
S60 3.2
Returns:
Name of the wlan network.
static IMPORT_C CConnMonWlanNetwork* CConnMonWlanNetwork::NewL CConnMonWlanNetwork aConnMonWlanNetwork  )  [static]
 

Copy constructor.

Since:
S60 3.2
Parameters:
aConnMonWlanNetwork The object which is copied.
Returns:
Pointer to the created CConnMonWlanNetwork object.
static IMPORT_C CConnMonWlanNetwork* CConnMonWlanNetwork::NewL  )  [static]
 

Constructor.

Since:
S60 3.2
Returns:
Pointer to the created empty CConnMonWlanNetwork object.
static IMPORT_C CConnMonWlanNetwork* CConnMonWlanNetwork::NewL const TBuf< KMaxNameLength > &  aName,
TUint  aConnectionMode,
TUint  aSignalStrength,
TUint  aSecurityMode,
const TBuf8< KWlanBssId > &  aBssId,
const TDesC &  aVendorData
[static]
 

Constructor.

Since:
S60 3.2
Parameters:
aName Name (SSID) of the network.
aConnectionMode Mode of the network.
aSignalStrength Signal strength of the network.
aSecurityMode Security mode of the network.
aBssId Mac address (BSSID) of the base station.
aVendorData Not in use.
Returns:
Pointer to the created CConnMonWlanNetwork object.
IMPORT_C CConnMonWlanNetwork& CConnMonWlanNetwork::operator= CConnMonWlanNetwork aConnMonWlanNetwork  ) 
 

Assignment operator.

Since:
S60 3.2
Parameters:
aConnMonWlanNetwork The object which is assigned.
TUint CConnMonWlanNetwork::SecurityMode  )  [inline]
 

Obtains the security mode of the network.

Since:
S60 3.2
Returns:
Security mode (defined in TConnMonSecurityMode).
TUint CConnMonWlanNetwork::SignalStrength  )  [inline]
 

Obtains the signal strength of the network.

Since:
S60 3.2
Returns:
Signal strength in dBm.
const HBufC* CConnMonWlanNetwork::ToBuf  )  const
 

Writes object of class CConnMonWlanNetwork to memory.

Ownership of newly created buffer is transferred to caller.

Since:
S60 3.2
Returns:
Pointer to heap descriptor. NULL if memory allocation failed.
HBufC* CConnMonWlanNetwork::VendorData  )  [inline]
 

Obtaina a pointer to vendor specific data buffer.

Ownership of the data is NOT transferred. Not in use, use package attribute KWlanProbeRawBuffers instead.

Since:
S60 3.2
Returns:
Pointer to vendor specific data if available.
TBuf8<KWlanBssId> CConnMonWlanNetwork::WlanBssid  )  [inline]
 

Obtains the mac address (BSSID) of the base station.

Since:
S60 3.2
Returns:
Mac address (BSSID).

Field Documentation

const TUint CConnMonWlanNetwork::KExtraCount = 10 [static]
 

Reserved for future use.

const TUint CConnMonWlanNetwork::KMaxNameLength = 32 [static]
 

Maximum length of a WLAN name (SSID).

const TUint CConnMonWlanNetwork::KWlanBssId = 6 [static]
 

WLAN BSSID length (mac address).


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top