/*

* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  RConnectionMonitor provides an interface for an application to

*                get information about active data connection. It also provides

*                a way to close any connection or all the connections.

*

*/

#ifndef __CONNECTIONMONITOR_H

#define __CONNECTIONMONITOR_H

#include <e32base.h>

// ===========================================================================

// TInt attribute constants, used by GetIntAttribute, SetIntAttribute.

// ===========================================================================

//

/** Bearer, defined in TConnMonBearerType.

*/

const TUint KBearer = 1;

/** Network status, defined in TConnMonNetworkStatus.

*/

const TUint KNetworkStatus = 2;

/** Connection status, progress constants are from nifvar.h.

*/

const TUint KConnectionStatus = 3;

/** Protocol, defined in TConnMonProtocolType.

*/

const TUint KProtocolType = 4;

/** Network registration values defined in TConnMonNetworkRegistration.

*/

const TUint KNetworkRegistration = 5;

/** Signal strength in dBm.

*/

const TUint KSignalStrength = 6;

/** WLAN mode, defined in TConnMonNetworkMode.

*/

const TUint KNetworkMode = 7;

/** WLAN connection security mode, defined in TConnMonSecurityMode.

*/

const TUint KSecurityMode = 8;

/** Bearer information, defined in TConnMonBearerInfo.

*/

const TUint KBearerInfo = 9;

/** Acceptable WLAN scan cache age in seconds. Set to -1 to use device

default. Only has meaning if KWlanScanMaxDelay is set to 0.

*/

const TUint KWlanScanCacheLifetime = 10;

/** Network registration values defined in TConnMonNetworkRegistration_v2.

*/

const TUint KNetworkRegistration_v2 = 11;

/** QoS - Not supported.

*/

const TUint KTrafficClass = 30;

/** QoS - Not supported.

*/

const TUint KDeliveryOrder = 31;

/** QoS - Not supported.

*/

const TUint KErroneousSDUDelivery = 32;

/** QoS - Not supported.

*/

const TUint KResidualBitErrorRatio = 33;

/** QoS - Not supported.

*/

const TUint KSDUErrorRatio = 34;

// ===========================================================================

// TUint attribute constants, used by GetUintAttribute, SetUintAttribute.

// ===========================================================================

//

/** Downlink data in bytes.

*/

const TUint KDownlinkData = 100;

/** Uplink data in bytes.

*/

const TUint KUplinkData = 101;

/** Used IAP ID.

*/

const TUint KIAPId = 102;

/** Network ID.

*/

const TUint KNetworkIdentifier = 103;

/** WLAN transmit power in mW.

*/

const TUint KTransmitPower = 104;

/** Current network mode, defined in TConnMonMobilePhoneNetworkMode.

*/

const TUint KMobilePhoneNetworkMode = 105;

/** QoS - Not supported.

*/

const TUint KMaximumBitrateDownlink = 130;

/** QoS - Not supported.

*/

const TUint KMaximumBitrateUplink = 131;

/** QoS - Not supported.

*/

const TUint KMaximumSDUSize = 132;

/** QoS - Not supported.

*/

const TUint KTransferDelay = 133;

/** QoS - Not supported.

*/

const TUint KGuaranteedBitrateDownlink = 134;

/** QoS - Not supported.

*/

const TUint KGuaranteedBitrateUplink = 135;

/** QoS - Not supported.

*/

const TUint KTrafficHandlingPriority = 136;

/** Enables EConnMonConnectionActivityChange events.

0 means off, minimum allowed is 5 seconds.

*/

const TUint KActivityTimeThreshold = 150;

/** Enables EConnMonDownlinkDataThreshold events.

0 means off, minimum allowed is 4096 bytes.

*/

const TUint KDownlinkDataThreshold = 151;

/** Enables EConnMonUplinkDataThreshold events.

0 means off, minimum allowed is 4096 bytes.

*/

const TUint KUplinkDataThreshold = 152;

/** Enables EConnMonBearerAvailabilityChange events.

*/

const TUint KBearerAvailabilityThreshold = 153;

/** Enables EConnMonSignalStrengthChange events.

*/

const TUint KSignalStrengthThreshold = 154;

/** If set, disables EConnMonBearerChange events and enables

EConnMonBearerInfoChange and EConnMonBearerGroupChange events instead.

*/

const TUint KBearerGroupThreshold = 155;

/** Acceptable delay in seconds for receiving WLAN scan results.

If set to 0 (default), KWlanScanCacheLifetime will be used.

*/

const TUint KWlanScanMaxDelay = 160;

// ===========================================================================

// TBool attribute constants, used by GetBoolAttribute, SetBoolAttribute.

// ===========================================================================

//

/** Connection activity.

*/

const TUint KConnectionActive = 200;

/** Bearer availability.

*/

const TUint KBearerAvailability = 201;

/** Packet data availability. Can be blocked if phone call is active and no

dual transfer mode support.

*/

const TUint KPacketDataAvailability = 202;

/** Stop a connection.

*/

const TUint KConnectionStop = 250;

/** Stop all connections.

*/

const TUint KConnectionStopAll = 251;

// ===========================================================================

// TDes attribute constants, used by GetStringAttribute, SetStringAttribute.

// ===========================================================================

//

/** Name of used IAP.

*/

const TUint KIAPName = 300;

/** Name of used access point.

*/

const TUint KAccessPointName = 301;

/** Used telephone number.

*/

const TUint KTelNumber = 302;

/** Name (SSID) of used WLAN.

*/

const TUint KNetworkName = 303;

/** WLAN name (SSID) to be used in SSID scan (KWlanSsidNetworks).

*/

const TUint KWlanSsid = 304;

// ===========================================================================

// TPckgBuf attribute constants, used by GetPckgAttribute.

// ===========================================================================

//

/** Connection start time. See TConnMonTimeBuf.

*/

const TUint KStartTime = 400;

/** All clients using a connection. See TConnMonClientEnumBuf.

*/

const TUint KClientInfo = 401;

/** Basic WLAN scan information. See TConnMonNetworkNamesBuf.

*/

const TUint KNetworkNames = 402;

/** Available IAP IDs. See TConnMonIapInfoBuf.

*/

const TUint KIapAvailability = 403;

/** Deprecated. Old WLAN scan results, use KWlanNetworks instead.

*/

const TUint KWLANNetworks = 404;

/** Available SNAP IDs. See TConnMonSNAPInfoBuf.

*/

const TUint KSNAPsAvailability = 405;

/** Available SNAP IDs, in a more flexible way. See ConnMonIdsArrayPckg.

*/

const TUint KAvailableSNAPsIds = 406;

/** WLAN scan results. See CConnMonWlanNetworksPtrArrayPckg.

*/

const TUint KWlanNetworks = 407;

/** Bearer group information. See TConnMonBearerGroupInfoBuf.

*/

const TUint KBearerGroupInfo = 408;

/** WLAN SSID scan results. Scans for WLANs with a specific SSID.

See CConnMonWlanNetworksPtrArrayPckg.

*/

const TUint KWlanSsidNetworks = 409;

/** Information about the currently used WLAN.

See CConnMonWlanNetworksPtrArrayPckg.

*/

const TUint KWlanCurrentNetwork = 410;

/** Beacon frames from a WLAN scan. See CConnMonWlanProbeRawBuffersPckg.

*/

const TUint KWlanProbeRawBuffers = 411;

/** Base value for plug-in specific attribute IDs.

*/

const TUint KConnMonPluginAttributeBase = 3000000;

/**

* Bearer type.

*/

enum TConnMonBearerType

    {

    EBearerUnknown           = 0,

    EBearerCSD               = 1,  ///< CSD (GSM)

    EBearerWCDMA             = 2,  ///< PSD (WCDMA)

    EBearerLAN               = 3,

    EBearerCDMA2000          = 4,

    EBearerGPRS              = 5,

    EBearerHSCSD             = 6,  ///< HSCSD (GSM)

    EBearerEdgeGPRS          = 7,

    EBearerWLAN              = 8,

    EBearerBluetooth         = 9,

    EBearerVirtual           = 10,

    EBearerVirtualVPN        = 11,

    EBearerWcdmaCSD          = 12, ///< CSD (WCDMA)

    EBearerExternalCSD       = 30, ///< external CSD (GSM)

    EBearerExternalWCDMA     = 31, ///< external PSD (WCDMA)

    EBearerExternalLAN       = 32,

    EBearerExternalCDMA2000  = 33,

    EBearerExternalGPRS      = 34,

    EBearerExternalHSCSD     = 35, ///< external HSCSD (GSM)

    EBearerExternalEdgeGPRS  = 36,

    EBearerExternalWLAN      = 37,

    EBearerExternalBluetooth = 38,

    EBearerExternalWcdmaCSD  = 39, ///< external CSD (WCDMA)

    };

/**

* Bearer specific general connection ID.

*/

enum TConnMonBearerId

    {

    EBearerIdAll        = 0,

    EBearerIdGPRS       = 2000000, ///< Internal/external GPRS and EdgeGPRS

    EBearerIdWCDMA      = 2000001, ///< Internal/external PSD (WCDMA)

    EBearerIdCSD        = 2000002, ///< Internal/external CSD and HSCSD (GSM)

    EBearerIdGSM        = 2000003, ///< Union of EBearerIdGPRS and EBearerIdCSD

    EBearerIdWLAN       = 2000004,

    EBearerIdLAN        = 2000005,

    EBearerIdWcdmaCSD   = 2000006, ///< Internal/external CSD (WCDMA)

    EBearerIdCDMA2000   = 2000007,

    EBearerIdVirtualVPN = 2000008

    };

/**

* Network status.

*/

enum TConnMonNetworkStatus

    {

    EConnMonStatusNotAvailable = 0,

    EConnMonStatusUnattached,

    EConnMonStatusAttached,

    EConnMonStatusActive,

    EConnMonStatusSuspended

    };

/**

* Protocol type (type of PDP). It may not be available for some

* bearers (returns EProtocolTypeUnknown).

*/

enum TConnMonProtocolType

    {

    EProtocolTypeUnknown = 0,

    EProtocolTypeIPv4,

    EProtocolTypeIPv6,

    EProtocolTypeX25,

    EProtocolTypePPP,

    EProtocolTypeCDPD,

    EProtocolTypeIP           ///< Connection uses both IPv4 and IPv6

    };

/**

* Asyncronous request codes.

*/

enum TConnMonAsyncRequest

    {

    EConnMonGetConnectionCount = 1,

    EConnMonGetIntAttribute,

    EConnMonGetUintAttribute,

    EConnMonGetBoolAttribute,

    EConnMonGetStringAttribute,

    EConnMonGetPckgAttribute

    };

/**

* Events sent by Connection Monitor. See SDK documentation for more details.

*/

enum TConnMonEvent

    {

    EConnMonCreateConnection          = 1,

    EConnMonDeleteConnection          = 2,

    EConnMonCreateSubConnection       = 3,  ///< Not supported

    EConnMonDeleteSubConnection       = 4,  ///< Not supported

    EConnMonDownlinkDataThreshold     = 5,

    EConnMonUplinkDataThreshold       = 6,

    EConnMonNetworkStatusChange       = 7,

    EConnMonConnectionStatusChange    = 8,

    EConnMonConnectionActivityChange  = 9,

    EConnMonNetworkRegistrationChange = 10,

    EConnMonBearerChange              = 11,

    EConnMonSignalStrengthChange      = 12, ///< For cellular, not WLAN

    EConnMonBearerAvailabilityChange  = 13,

    EConnMonIapAvailabilityChange     = 14,

    EConnMonTransmitPowerChange       = 15, ///< For WLAN

    EConnMonSNAPsAvailabilityChange   = 16,

    EConnMonNewWLANNetworkDetected    = 17,

    EConnMonOldWLANNetworkLost        = 18,

    EConnMonPacketDataAvailable       = 19,

    EConnMonPacketDataUnavailable     = 20,

    EConnMonBearerInfoChange          = 21,

    EConnMonBearerGroupChange         = 22,

    EConnMonPluginEventBase           = 4000000

    };

/**

* Network registration status. Valid for CSD, GPRS and WCDMA.

*/

enum TConnMonNetworkRegistration

    {

    ENetworkRegistrationNotAvailable = 0,

    ENetworkRegistrationUnknown,

    ENetworkRegistrationNoService,

    ENetworkRegistrationEmergencyOnly,

    ENetworkRegistrationSearching,

    ENetworkRegistrationBusy,

    ENetworkRegistrationHomeNetwork,

    ENetworkRegistrationDenied,

    ENetworkRegistrationRoaming

    };

/**

* Network registration status. Valid for CSD, GPRS and WCDMA.

* New values will be added to the end of the enumeration.

*/

enum TConnMonNetworkRegistration_v2

    {

    ENetworkRegistrationExtNotAvailable = 0,

    ENetworkRegistrationExtUnknown,

    ENetworkRegistrationExtNoService,

    ENetworkRegistrationExtEmergencyOnly,

    ENetworkRegistrationExtSearching,

    ENetworkRegistrationExtBusy,

    ENetworkRegistrationExtHomeNetwork,

    ENetworkRegistrationExtDenied,

    ENetworkRegistrationExtRoamingNational,

    ENetworkRegistrationExtRoamingInternational

    };

/**

* QoS. Traffic class.

*/

enum TQosTrafficClass

    {

    EQosTrafficClassConversational = 1,

    EQosTrafficClassStreaming,

    EQosTrafficClassInteractive,

    EQosTrafficClassBackground

    };

/**

* QoS. Delivery order.

*/

enum TQosDeliveryOrder

    {

    EQosDeliveryOrderYes = 1,

    EQosDeliveryOrderNo

    };

/**

* QoS. Delivery of erroneous SDUs.

*/

enum TQosErroneousSDUDelivery

    {

    EQosErroneousSDUDeliveryYes = 1,

    EQosErroneousSDUDeliveryNo,

    EQosErroneousSDUDeliveryUnspecified

    };

/**

* QoS. Residual bit error ratio.

*/

enum TQosBitErrorRatio

    {

    EQosBERFivePerHundred = 1,

    EQosBEROnePerHundred,

    EQosBERFivePerThousand,

    EQosBEROnePerThousand,

    EQosBEROnePerTenThousand,

    EQosBEROnePerMillion

    };

/**

* QoS. SDU error ratio.

*/

enum TQosSDUErrorRatio

    {

    EQosSDUErrorRatioOnePerHundred = 1,

    EQosSDUErrorRatioSevenPerThousand,

    EQosSDUErrorRatioOnePerThousand,

    EQosSDUErrorRatioOnePerTenThousand,

    EQosSDUErrorRatioOnePerHundredThousand

    };

/**

* Client-server requests.

*/

enum TConnMonRequests

    {

    EReqGetConnectionCount            = 0,

    EReqGetConnectionInfo             = 1,

    EReqGetSubConnectionInfo          = 2,

    EReqGetIntAttribute               = 3,

    EReqGetUintAttribute              = 4,

    EReqGetBoolAttribute              = 5,

    EReqGetStringAttribute            = 6,

    EReqGetPckgAttribute              = 7,

    EReqSetIntAttribute               = 8,

    EReqSetUintAttribute              = 9,

    EReqSetBoolAttribute              = 10,

    EReqSetStringAttribute            = 11,

    EReqSetPckgAttribute              = 12,

    EReqCancelAsyncRequest            = 13,

    EReqReceiveEvent                  = 14,

    EReqCancelReceiveEvent            = 15,

    EReqPluginCreateSubSession        = 500,

    EReqPluginCloseSubSession         = 501,

    EReqPluginRegisterAttribute       = 502,

    EReqPluginCancelRegisterAttribute = 503,

    EReqPluginEvent                   = 504,

    EReqPluginGetQuery                = 505,

    EReqPluginCancelGetQuery          = 506,

    EReqPluginAttribute               = 507,

    EReqInternalSetThreshold          = 600,

    EReqInternalResetThreshold        = 601

    };

/**

* WLAN connection modes.

*/

enum TConnMonNetworkMode

    {

    EConnMonInfraStructure = 0,

    EConnMonAdHoc          = 1,

    EConnMonSecureInfra    = 2

    };

/**

* WLAN connection security modes.

*/

enum TConnMonSecurityMode

    {

    EConnMonSecurityOpen   = 0,

    EConnMonSecurityWep    = 1,

    EConnMonSecurity802d1x = 2,

    EConnMonSecurityWpa    = 3,

    EConnMonSecurityWpaPsk = 4

    };

/**

* Network Modes.

*/

enum TConnMonMobilePhoneNetworkMode

    {

    EConnMonNetworkModeUnknown = 0,  ///< Network mode is unknown

    EConnMonNetworkModeUnregistered, ///< ME is not registered

    EConnMonNetworkModeGsm,          ///< GSM/GPRS or DCS1800 network

    EConnMonNetworkModeAmps,         ///< AMPS network (CDMA)

    EConnMonNetworkModeCdma95,       ///< CDMA (IS-95) network

    EConnMonNetworkModeCdma2000,     ///< CDMA (cdma2000) network

    EConnMonNetworkModeWcdma,        ///< WCDMA (UTRA FDD) network

    EConnMonNetworkModeTdcdma        ///< TD-CDMA (UTRA TDD) network (WCDMA)

    };

/** Maximum size of a plug-in's event data.

*/

const TUint KConnMonMaxPluginDataSize = 512;