satengine/satserver/Engine/inc/CSatApnHandler.h
author hgs
Tue, 10 Aug 2010 13:19:41 +0300
changeset 38 bc103bfb69cf
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201031_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2010 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Handles APN operations
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef CSATAPNHANDLER_H
hgs
parents:
diff changeset
    21
#define CSATAPNHANDLER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
#include "MSatApnHandler.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
class MSatUtils;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
*  Handles the Access point operations with CMManager. Searches, inserts and
hgs
parents:
diff changeset
    31
*  deletes APNs, if neccessary
hgs
parents:
diff changeset
    32
*
hgs
parents:
diff changeset
    33
*  @lib SatEngine
hgs
parents:
diff changeset
    34
*  @since S60 3.0
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
class CSatApnHandler : public CBase,
hgs
parents:
diff changeset
    37
                       public MSatApnHandler
hgs
parents:
diff changeset
    38
    {
hgs
parents:
diff changeset
    39
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
        /**
hgs
parents:
diff changeset
    42
        * Two-phased constructor.
hgs
parents:
diff changeset
    43
        * @param aUtils Reference to SAT Utils
hgs
parents:
diff changeset
    44
        */
hgs
parents:
diff changeset
    45
        static CSatApnHandler* NewL( MSatUtils& aUtils );
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
        /**
hgs
parents:
diff changeset
    48
        * Destructor.
hgs
parents:
diff changeset
    49
        */
hgs
parents:
diff changeset
    50
        virtual ~CSatApnHandler();
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
    public: // Functions from MSatApnHandler
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
        /**
hgs
parents:
diff changeset
    55
        * Locates APN from CMManager, creates new APN if not found, and
hgs
parents:
diff changeset
    56
        * returns IAP id and Network ID in referenced parameters
hgs
parents:
diff changeset
    57
        * @param aName Accesspoint to locate / create
hgs
parents:
diff changeset
    58
        * @param aUserLogin, User name in case new APN is needed
hgs
parents:
diff changeset
    59
        * @param aUserPwd, Password in case, new APN is needed
hgs
parents:
diff changeset
    60
        * @param aIapId, after completion, holds the IAP id of the APN
hgs
parents:
diff changeset
    61
        * @param aNwId, after completion, holds the Network id of the APN
hgs
parents:
diff changeset
    62
        * @param aApnCreated indicates is new APN created
hgs
parents:
diff changeset
    63
        * @param aPdpType, indicates whether the address type is IPv4  or IPv6
hgs
parents:
diff changeset
    64
        * @param aLocalAddress, represents the Local Address provided by NAA
hgs
parents:
diff changeset
    65
        */
hgs
parents:
diff changeset
    66
        void GetApnInfoL(
hgs
parents:
diff changeset
    67
            const RSat::TAccessName& aName,
hgs
parents:
diff changeset
    68
            const RSat::TTextString& aUserLogin,
hgs
parents:
diff changeset
    69
            const RSat::TTextString& aUserPwd,
hgs
parents:
diff changeset
    70
            TUint32& aIapId,
hgs
parents:
diff changeset
    71
            TUint32& aNwId,
hgs
parents:
diff changeset
    72
            TBool& aApnCreated,
hgs
parents:
diff changeset
    73
            const RPacketContext::TProtocolType& aPdpType,
hgs
parents:
diff changeset
    74
            const TDesC8& aLocalAddress );
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
        /**
hgs
parents:
diff changeset
    77
        * Deletes the connection method with given APN ID. Note that aApnId is 
hgs
parents:
diff changeset
    78
        * the same id that GetApnInfoL returns in aNwId.
hgs
parents:
diff changeset
    79
        * @param aApnId APN to delete
hgs
parents:
diff changeset
    80
        */
hgs
parents:
diff changeset
    81
        void DeleteApnL( TUint32 aApnId );
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
        /**
hgs
parents:
diff changeset
    84
         * Find the default APN Id
hgs
parents:
diff changeset
    85
         * @param aPdpType, indicates the address type is IPv4  or IPv6
hgs
parents:
diff changeset
    86
         * @return a default iap id
hgs
parents:
diff changeset
    87
         */
hgs
parents:
diff changeset
    88
        TUint32 FindDefaultApL(
hgs
parents:
diff changeset
    89
                const RPacketContext::TProtocolType& aPdpType );
hgs
parents:
diff changeset
    90
    private:
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
        * C++ default constructor.
hgs
parents:
diff changeset
    94
        * @param aUtils Reference to SAT Utils
hgs
parents:
diff changeset
    95
        */
hgs
parents:
diff changeset
    96
        CSatApnHandler( MSatUtils& aUtils );
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
        /**
hgs
parents:
diff changeset
    99
        * create a new connection method  in case, access point does not exist
hgs
parents:
diff changeset
   100
        * @param aReqApn Formatted required access point name.
hgs
parents:
diff changeset
   101
        * @param aUserLogin User name
hgs
parents:
diff changeset
   102
        * @param aUserPwd Password
hgs
parents:
diff changeset
   103
        * @param aIapId, after completion, holds the IAP id of the new APN
hgs
parents:
diff changeset
   104
        * @param aNwId, after completion, holds the Network id of the new APN
hgs
parents:
diff changeset
   105
        * @param aPdpType, indicates whether the address type is IPv4  or IPv6
hgs
parents:
diff changeset
   106
        * @param aLocalAddress, represents the Local Address provided by NAA
hgs
parents:
diff changeset
   107
        */
hgs
parents:
diff changeset
   108
        void InsertRecordL(
hgs
parents:
diff changeset
   109
            const TDesC& aReqApn,
hgs
parents:
diff changeset
   110
            const RSat::TTextString& aUserLogin,
hgs
parents:
diff changeset
   111
            const RSat::TTextString& aUserPwd,
hgs
parents:
diff changeset
   112
            TUint32& aIapId,
hgs
parents:
diff changeset
   113
            TUint32& aNwId,
hgs
parents:
diff changeset
   114
            const RPacketContext::TProtocolType aPdpType,
hgs
parents:
diff changeset
   115
            const TDesC8& aLocalAddress );
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
        /**
hgs
parents:
diff changeset
   118
        * Formats the APN from SIM into correct format.
hgs
parents:
diff changeset
   119
        * @param aReqApn Accesspoint to format
hgs
parents:
diff changeset
   120
        * @return Returns formatted APN in an HBufC
hgs
parents:
diff changeset
   121
        *         Invoker is responsible to release
hgs
parents:
diff changeset
   122
        *         the memory! 
hgs
parents:
diff changeset
   123
        */
hgs
parents:
diff changeset
   124
        HBufC* FormatAPN( const RSat::TAccessName& aReqApn ) const;
hgs
parents:
diff changeset
   125
hgs
parents:
diff changeset
   126
    private:  // Data
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
        // Reference to command container
hgs
parents:
diff changeset
   129
        MSatUtils& iUtils;
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
    };
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
#endif      // CSATAPNHANDLER_H
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
// End of File