diff -r 000000000000 -r 3553901f7fa8 telephonyserverplugins/simatktsy/inc/CSatNotifyPlayTone.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/telephonyserverplugins/simatktsy/inc/CSatNotifyPlayTone.h Tue Feb 02 01:41:59 2010 +0200 @@ -0,0 +1,136 @@ +/* +* Copyright (c) 2005-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: +* Name : CSatNotifyPlayTone.h +* Part of : Common SIM ATK TSY / commonsimatktsy +* Specific notifications class +* Version : 1.0 +* +*/ + + + +#ifndef CSATNOTIFYPLAYTONE_H +#define CSATNOTIFYPLAYTONE_H + + +// INCLUDES +#include +#include "MSatNotificationsBase.h" + +// FORWARD DECLARATIONS +class CSatDataPackage; +class CSatNotificationsTsy; + +/** +* DESCRIPTION +* SAT Play Tone notification class. +* Created when client requests to be notified when Play Tone +* command arrives from SIM. +* +* This command instructs the SAT to play an audio tone. +* @lib Commonsimatktsy +* @since 3.1 +*/ +NONSHARABLE_CLASS ( CSatNotifyPlayTone ) : public CBase, + public MSatNotificationsBase + { + public: // Constructors and destructor + + /** + * Two-phased constructor. + * @param aNotificationsTsy: Pointer to NotificationsTsy + * return CSatNotifyPlayTone*: created object + */ + static CSatNotifyPlayTone* NewL( + CSatNotificationsTsy* aNotificationsTsy ); + + /** + * C++ Destructor. + */ + ~CSatNotifyPlayTone(); + + private: + + /** + * By default C++ constructor is private. + * @param aNotificationsTsy: Pointer to NotificationsTsy + * @return None + */ + CSatNotifyPlayTone( CSatNotificationsTsy* aNotificationsTsy ); + + /** + * Class attributes are created in ConstructL. + * @param None + * @return None + */ + void ConstructL(); + + public: // Functions from base classes + + /** + * Play Tone Notification request received from client + * @param aTsyReqHandle: request handle from ETel + * @param aPackage: Packed data + * @return KErrNone + */ + TInt Notify( const TTsyReqHandle aTsyReqHandle, + const TDataPackage& aPackage ); + + /** + * Cancels notification request for Play Tone. + * @param aReqHandle notify request handle + * @return KErrNone + */ + TInt CancelNotification( const TTsyReqHandle aReqHandle ); + + /** + * Completes Play Tone message to client + * @param aDataPackage: Packaged return data + * @param aErrorCode: Possible error code + * @return KErrNone/ KErrCorrupt + */ + TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode ); + + /** + * From CSatNotificationsBase handles Play Tone terminal response + * coming from client. + * @param aRsp: Response structure + * @return KErrNone/ KErrCorrupt + */ + TInt TerminalResponseL( TDes8* aRsp ); + + public: // New functions + + /** + * Create notification specific terminal response data + * @param aPCmdNumber: Proactive command number + * @param aGeneralResult: Result of the proactive command + * @param aAdditionalInfo: Additional info for terminal response + * @return Success/Failure value + */ + TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult, + TDesC16& aAdditionalInfo ); + + private: // Data + + // Play Tone package store. Package allocated + // in this class and received from ETel + RSat::TPlayToneV2Pckg* iPlayToneV2Pckg; + // Pointer to the notifications tsy class + CSatNotificationsTsy* iNotificationsTsy; + }; + + +#endif // CSATNOTIFYPLAYTONE_H \ No newline at end of file