CConnMonWlanNetwork Class Reference

API published in: S60 2nd Ed FP 2

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

CConnMonWlanNetwork is a class, incapsulated Wlan network abstraction Is able to be transferred through processes (client/server) in object's size-independent manner, to meet backward/forward compatibility.

Public Member Functions
IMPORT_C  ~CConnMonWlanNetwork ()
  Destructor.
IMPORT_C CConnMonWlanNetwork &  operator= (CConnMonWlanNetwork &aConnMonWlanNetwork)
  Assignment operator.
TBuf< KMaxNameLength >  Name ()
  Returns the name(SSID) of the network.
TUint  ConnectionMode ()
  Returns the connection mode of the network.
TUint  SignalStrength ()
  Returns the signal strength of the network.
TUint  SecurityMode ()
  Returns the security mode of the network.
TBuf8< KWlanBssId >  WlanBssid ()
  Returns the WLAN bssid.
HBufC *  VendorData ()
  Returns the pointer to the Vendor specific data buffer.
const HBufC *  ToBuf () const
  Packs the object of class to HBufC Ownership of newly created pointer is transferred to caller.

Static Public Member Functions
static IMPORT_C CConnMonWlanNetwork *  NewL (const TBuf< KMaxNameLength > &aName, TUint aConnectionMode, TUint aSignalStrength, TUint aSecurityMode, const TBuf8< KWlanBssId > &aBssId, const TDesC &aVendorData)
  Constructor.
static IMPORT_C CConnMonWlanNetwork *  NewL ()
  Constructor.
static IMPORT_C CConnMonWlanNetwork *  NewL (CConnMonWlanNetwork &aConnMonWlanNetwork)
  Copy constructor.
static IMPORT_C TInt  CompareBySignal (const CConnMonWlanNetwork &aFirst, const CConnMonWlanNetwork &aSecond)
  Compares two networks by iSignalStrength;.
static TInt  FromPtrC (const TPtrC &aPtrC, CConnMonWlanNetwork *aConnMonWlanNetwork)
  Unpacks object of class CConnMonWlanNetwork from aPtrC.

Static Public Attributes
static const TUint  KMaxNameLength = 32
static const TUint  KWlanBssId = 6
static const TUint  KExtraCount = 10

Constructor & Destructor Documentation

IMPORT_C CConnMonWlanNetwork::~CConnMonWlanNetwork (   ) 
 

Destructor.

Member Function Documentation

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

Compares two networks by iSignalStrength;.

Parameters:
aFirst  to be compared with aSecond
Returns:
Returns 1 if aFirst is less than aSecond, 0 if they are equal and -1 otherwise
TUint CConnMonWlanNetwork::ConnectionMode (   )  [inline]
 

Returns the connection mode of the network.

Returns:
Returns the connection mode (defined in TConnMonNetworkMode)
static TInt CConnMonWlanNetwork::FromPtrC (  const TPtrC &  aPtrC,
CConnMonWlanNetwork *  aConnMonWlanNetwork
)  [static]
 

Unpacks object of class CConnMonWlanNetwork from aPtrC.

Returns:
Returns KErrNone is succeed. Otherwise returns system-wide error code.
TBuf<KMaxNameLength> CConnMonWlanNetwork::Name (   )  [inline]
 

Returns the name(SSID) of the network.

Returns:
Returns the name of the wlan network if exists. Otherwise returns empty buffer.
static IMPORT_C CConnMonWlanNetwork* CConnMonWlanNetwork::NewL (  CConnMonWlanNetwork &  aConnMonWlanNetwork  )  [static]
 

Copy constructor.

Parameters:
aConnMonWlanNetwork  An object which is copied.
Returns:
Returns pointer to the created CConnMonWlanNetwork object.
static IMPORT_C CConnMonWlanNetwork* CConnMonWlanNetwork::NewL (   )  [static]
 

Constructor.

Returns:
Returns pointer to the created CConnMonWlanNetwork object. Data members are empty.
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.

Parameters:
aName  name of the network
aConnectionMode  ConnectionMode of the network
aSignalStrength  Signal strength of the network
aSecurityMode  Security mode of the network
aBssId  Bssid of the network
aVendorData  Vendordata of the network
Returns:
Returns pointer to the created CConnMonWlanNetwork object.
IMPORT_C CConnMonWlanNetwork& CConnMonWlanNetwork::operator= (  CConnMonWlanNetwork &  aConnMonWlanNetwork  ) 
 

Assignment operator.

Parameters:
An  object which is assigned.
TUint CConnMonWlanNetwork::SecurityMode (   )  [inline]
 

Returns the security mode of the network.

Returns:
Returns the security mode.
TUint CConnMonWlanNetwork::SignalStrength (   )  [inline]
 

Returns the signal strength of the network.

Returns:
Returns the signal strength
const HBufC* CConnMonWlanNetwork::ToBuf (   )  const
 

Packs the object of class to HBufC Ownership of newly created pointer is transferred to caller.

Returns:
pointer to heap descriptor
HBufC* CConnMonWlanNetwork::VendorData (   )  [inline]
 

Returns the pointer to the Vendor specific data buffer.

Ownership of the data is NOT transferred.

Returns:
Returns the vendor specific data if available. Otherwise returns NULL.
TBuf8<KWlanBssId> CConnMonWlanNetwork::WlanBssid (   )  [inline]
 

Returns the WLAN bssid.

Returns:
Returns the WLAN bssid.

Field Documentation

const TUint CConnMonWlanNetwork::KExtraCount = 10 [static]
 
const TUint CConnMonWlanNetwork::KMaxNameLength = 32 [static]
 
const TUint CConnMonWlanNetwork::KWlanBssId = 6 [static]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top