CConnMonWlanNetwork Class Reference

#include <mw/rconnmon.h>

Link against: ConnMon.lib

class CConnMonWlanNetwork : public CBase

Inherits from

  • CConnMonWlanNetwork
    Public Attributes
    const TUintKExtraCount
    const TUintKMaxNameLength
    const TUintKWlanBssId
    Public Member Functions
    ~CConnMonWlanNetwork()
    IMPORT_C TIntCompareBySignal(const CConnMonWlanNetwork &, const CConnMonWlanNetwork &)
    TUint ConnectionMode()
    IMPORT_C TIntFromPtrC(const TPtrC &, CConnMonWlanNetwork *)
    TBuf< KMaxNameLength >Name()
    IMPORT_C CConnMonWlanNetwork *NewL(const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC &)
    IMPORT_C CConnMonWlanNetwork *NewL()
    IMPORT_C CConnMonWlanNetwork *NewL(CConnMonWlanNetwork &)
    TUint SecurityMode()
    TUint SignalStrength()
    IMPORT_C const HBufC *ToBuf()
    HBufC *VendorData()
    TBuf8< KWlanBssId >WlanBssid()
    IMPORT_C CConnMonWlanNetwork &operator=(CConnMonWlanNetwork &)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Class to represent a WLAN. Used when reporting WLAN scan results back to a client.

    Member Attribute Documentation

    KExtraCount

    const TUintKExtraCount[static]

    Reserved for future use.

    KMaxNameLength

    const TUintKMaxNameLength[static]

    Maximum length of a WLAN name (SSID).

    KWlanBssId

    const TUintKWlanBssId[static]

    WLAN BSSID length (mac address).

    Constructor & Destructor Documentation

    ~CConnMonWlanNetwork ( )

    IMPORT_C~CConnMonWlanNetwork()

    Destructor.

    Member Function Documentation

    CompareBySignal ( const CConnMonWlanNetwork &, const CConnMonWlanNetwork & )

    IMPORT_C TIntCompareBySignal(const CConnMonWlanNetwork &aFirst,
    const CConnMonWlanNetwork &aSecond
    )[static]

    Compares two networks by signal strength.

    ParameterDescription
    aFirstReference to first WLAN object.
    aSecondReference to second WLAN object.

    Returns: Result of the comparison, 1 if first is less than second, 0 if they are equal and -1 otherwise.

    ConnectionMode ( )

    TUint ConnectionMode()[inline]

    Obtains the connection mode of the network.

    Returns: Connection mode (defined in TConnMonNetworkMode).

    FromPtrC ( const TPtrC &, CConnMonWlanNetwork * )

    IMPORT_C TIntFromPtrC(const TPtrC &aPtrC,
    CConnMonWlanNetwork *aConnMonWlanNetwork
    )[static]

    Reads object of class CConnMonWlanNetwork from memory.

    ParameterDescription
    aPtrCPointer to the beginning of the CConnMonWlanNetwork object in buffer.
    aConnMonWlanNetworkPointer to CConnMonWlanNetwork object where unpacked contents are written.

    Returns: A Symbian OS error code.

    Name ( )

    TBuf< KMaxNameLength >Name()[inline]

    Obtains the name (SSID) of the network.

    Returns: Name of the wlan network.

    NewL ( const TBuf< KMaxNameLength > &, TUint, TUint, TUint, const TBuf8< KWlanBssId > &, const TDesC & )

    IMPORT_C CConnMonWlanNetwork *NewL(const TBuf< KMaxNameLength > &aName,
    TUintaConnectionMode,
    TUintaSignalStrength,
    TUintaSecurityMode,
    const TBuf8< KWlanBssId > &aBssId,
    const TDesC &aVendorData
    )[static]

    Constructor.

    ParameterDescription
    aNameName (SSID) of the network.
    aConnectionModeMode of the network.
    aSignalStrengthSignal strength of the network.
    aSecurityModeSecurity mode of the network.
    aBssIdMac address (BSSID) of the base station.
    aVendorDataNot in use.

    Returns: Pointer to the created CConnMonWlanNetwork object.

    NewL ( )

    IMPORT_C CConnMonWlanNetwork *NewL()[static]

    Constructor.

    Returns: Pointer to the created empty CConnMonWlanNetwork object.

    NewL ( CConnMonWlanNetwork & )

    IMPORT_C CConnMonWlanNetwork *NewL(CConnMonWlanNetwork &aConnMonWlanNetwork)[static]

    Copy constructor.

    ParameterDescription
    aConnMonWlanNetworkThe object which is copied.

    Returns: Pointer to the created CConnMonWlanNetwork object.

    SecurityMode ( )

    TUint SecurityMode()[inline]

    Obtains the security mode of the network.

    Returns: Security mode (defined in TConnMonSecurityMode).

    SignalStrength ( )

    TUint SignalStrength()[inline]

    Obtains the signal strength of the network.

    Returns: Signal strength in dBm.

    ToBuf ( )

    IMPORT_C const HBufC *ToBuf()const

    Writes object of class CConnMonWlanNetwork to memory. Ownership of newly created buffer is transferred to caller.

    Returns: Pointer to heap descriptor. NULL if memory allocation failed.

    VendorData ( )

    HBufC *VendorData()[inline]

    Obtains a pointer to vendor specific data buffer. Ownership of the data is NOT transferred. Not in use, use package attribute KWlanProbeRawBuffers instead.

    Returns: Pointer to vendor specific data if available.

    WlanBssid ( )

    TBuf8< KWlanBssId >WlanBssid()[inline]

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

    Returns: Mac address (BSSID).

    operator= ( CConnMonWlanNetwork & )

    IMPORT_C CConnMonWlanNetwork &operator=(CConnMonWlanNetwork &aConnMonWlanNetwork)

    Assignment operator.

    ParameterDescription
    aConnMonWlanNetworkThe object which is assigned.
    © Nokia 2011.