telephonyserverplugins/simatktsy/inc/CSatNotifyPollInterval.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        : CSatNotifyPollingInterval.h
       
    16 * Part of     : Common SIM ATK TSY / commonsimatktsy
       
    17 * Specific notifications class
       
    18 * Version     : 1.0
       
    19 *
       
    20 */
       
    21 
       
    22 
       
    23 
       
    24 #ifndef CSATNOTIFYPOLLINTERVAL_H
       
    25 #define CSATNOTIFYPOLLINTERVAL_H
       
    26 
       
    27 
       
    28 //  INCLUDES
       
    29 #include <etelsat.h>
       
    30 #include <e32math.h>
       
    31 #include "MSatNotificationsBase.h"
       
    32 
       
    33 // FORWARD DECLARATIONS
       
    34 class CSatDataPackage;
       
    35 class CSatNotificationsTsy;
       
    36 
       
    37 // DESCRIPTION
       
    38 /**
       
    39 * SAT Poll Interval notification class.
       
    40 * Created when client requests to be notified when Poll Interval
       
    41 * command arrives from SIM.
       
    42 *
       
    43 * This procedure negotiates how often the ME shall send STATUS commands 
       
    44 * related to Proactive Polling 
       
    45 * Does not require any interaction with the Symbian OS side, and has no impact
       
    46 * on the Etel API.
       
    47 * @lib Commonsimatktsy
       
    48 * @since 3.1
       
    49 */
       
    50 NONSHARABLE_CLASS ( CSatNotifyPollInterval ) : public CBase,
       
    51                            private MSatNotificationsBase
       
    52     {
       
    53     
       
    54     public:   // Constructors and destructor
       
    55         
       
    56         /**
       
    57         * Two-phased constructor.
       
    58         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    59         * return CSatNotifyPollInterval*: created object 
       
    60         */
       
    61         static CSatNotifyPollInterval* NewL( 
       
    62         	CSatNotificationsTsy* aNotificationsTsy );
       
    63 
       
    64         /**
       
    65         * C++ Destructor.
       
    66         */
       
    67         ~CSatNotifyPollInterval();
       
    68 
       
    69 	private:
       
    70 	
       
    71         /**
       
    72         * By default C++ constructor is private.
       
    73         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    74         * @return None
       
    75         */
       
    76         CSatNotifyPollInterval( CSatNotificationsTsy* aNotificationsTsy );
       
    77 
       
    78         /**
       
    79         * Class attributes are created in ConstructL. 
       
    80         * @param None
       
    81         * @return None
       
    82         */
       
    83         void ConstructL();
       
    84 
       
    85     public: // Functions from base classes
       
    86             
       
    87         /**
       
    88         * Completes PollInterval message to client
       
    89         * @param aDataPackage: Packaged return data
       
    90         * @param aErrorCode: Possible error code
       
    91         * @return KErrNone/ KErrCorrupt
       
    92         */
       
    93         TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );
       
    94 
       
    95 	public: // New functions
       
    96 	
       
    97         /**
       
    98         * Create notification specific terminal response data
       
    99         * @param aPCmdNumber: Proactive command number
       
   100         * @param aGeneralResult: Result of the proactive command
       
   101         * @param aAdditionalInfo: Additional info for terminal response
       
   102         * @param aDcs: Data Coding Scheme
       
   103         * @return Success/Failure value
       
   104         */
       
   105         TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,
       
   106         	TUint8 aAdditionalInfo, TUint8 aDcs );
       
   107 
       
   108 
       
   109     private: // Data
       
   110 
       
   111         RSat::TPollingIntervalRspV3 iPollingIntervalRspV3;
       
   112         // Pointer to the notifications tsy class
       
   113         CSatNotificationsTsy* iNotificationsTsy;
       
   114     };
       
   115 
       
   116 
       
   117 #endif // CSATNOTIFYPOLLINTERVAL_H