telephonyserverplugins/simatktsy/inc/CSatNotifySendDtmf.h
changeset 0 3553901f7fa8
child 24 6638e7f4bd8f
equal deleted inserted replaced
-1:000000000000 0:3553901f7fa8
       
     1 /*
       
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Name        : CSatNotifySendDtmf.h
       
    16 * Part of     : Common SIM ATK TSY / commonsimatktsy
       
    17 * Specific notifications class
       
    18 * Version     : 1.0
       
    19 *
       
    20 */
       
    21 
       
    22 
       
    23 
       
    24 #ifndef CSATNOTIFYSENDDTMF_H
       
    25 #define CSATNOTIFYSENDDTMF_H
       
    26 
       
    27 
       
    28 //  INCLUDES
       
    29 #include <etelsat.h>
       
    30 #include "MSatNotificationsBase.h"
       
    31 
       
    32 // FORWARD DECLARATIONS
       
    33 class CSatDataPackage;
       
    34 class CSatNotificationsTsy;
       
    35 
       
    36 /**
       
    37 * DESCRIPTION
       
    38 * @lib Commonsimatktsy
       
    39 * @since 3.1
       
    40 */
       
    41 NONSHARABLE_CLASS ( CSatNotifySendDtmf ) : public CBase,
       
    42                            public MSatNotificationsBase
       
    43     {
       
    44     public:   // Constructors and destructor
       
    45         
       
    46         /**
       
    47         * Two-phased constructor.
       
    48         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    49         * return CSatNotifySendDtmf*: created object 
       
    50         */
       
    51         static CSatNotifySendDtmf* NewL( 
       
    52         	CSatNotificationsTsy* aNotificationsTsy );
       
    53 
       
    54         /**
       
    55         * C++ Destructor.
       
    56         */
       
    57         ~CSatNotifySendDtmf();
       
    58 
       
    59 	private:
       
    60         /**
       
    61         * By default C++ constructor is private.
       
    62         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    63         * @return None
       
    64         */
       
    65         CSatNotifySendDtmf( CSatNotificationsTsy* aNotificationsTsy );
       
    66 
       
    67         /**
       
    68         * Class attributes are created in ConstructL. 
       
    69         * @param None
       
    70         * @return None
       
    71         */
       
    72         void ConstructL();
       
    73 
       
    74     public: // Functions from base classes
       
    75 
       
    76         /**
       
    77         * Send Dtmf Notification request received from client
       
    78         * @param aTsyReqHandle: request handle from ETel
       
    79         * @param aPackage: Packed data
       
    80         * @return KErrNone
       
    81         */
       
    82         TInt Notify( const TTsyReqHandle aTsyReqHandle,
       
    83             const TDataPackage& aPackage );
       
    84 
       
    85         /**
       
    86         * Cancels notification request for SendDtmf.
       
    87         * @param aReqHandle notify request handle
       
    88         * @return KErrNone
       
    89         */
       
    90         TInt CancelNotification( const TTsyReqHandle aReqHandle );
       
    91                  
       
    92         /**
       
    93         * Completes SendDtmf message to client
       
    94         * @param aDataPackage: Packaged return data
       
    95         * @param aErrorCode: Possible error code
       
    96         * @return KErrNone/ KErrCorrupt
       
    97         */
       
    98         TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );
       
    99 
       
   100         /**
       
   101         * From CSatNotificationsBase handles Send dtmf terminal response 
       
   102         * coming from client.
       
   103         * @param aRsp: Response structure
       
   104         * @return KErrNone/ KErrCorrupt
       
   105         */
       
   106         TInt TerminalResponseL( TDes8* aRsp );
       
   107 
       
   108     public: // New methods
       
   109     
       
   110         /**
       
   111         * Create notification specific terminal response data
       
   112         * @param aPCmdNumber: Proactive command number
       
   113         * @param aGeneralResult: Result of the proactive command
       
   114         * @param aAdditionalInfo: Additional info for terminal response
       
   115         * @return Success/Failure value
       
   116         */
       
   117         TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,
       
   118             					 TDesC16& aAdditionalInfo );  
       
   119 
       
   120     private: // Data
       
   121 
       
   122         // Send Dtmf package store. Package allocated
       
   123         // in this class and received from ETel
       
   124         RSat::TSendDtmfV1Pckg* iSendDtmfV1Pckg;
       
   125         // Pointer to the notifications tsy class
       
   126         CSatNotificationsTsy* iNotificationsTsy;
       
   127     };
       
   128 
       
   129 
       
   130 #endif // CSATNOTIFYSENDDTMF_H