--- a/ipsservices/ipssosaoplugin/inc/IpsSosAOPopAgent.h Thu Aug 19 09:38:05 2010 +0300
+++ b/ipsservices/ipssosaoplugin/inc/IpsSosAOPopAgent.h Tue Aug 31 15:04:17 2010 +0300
@@ -17,8 +17,8 @@
*/
-#ifndef IPSSOSAOPOPAGENT_H_
-#define IPSSOSAOPOPAGENT_H_
+#ifndef IPSSOSAOPOPAGENT_H
+#define IPSSOSAOPOPAGENT_H
#include <pop3set.h>
#include <mtclreg.h>
@@ -35,7 +35,9 @@
* implementations of base class pure virtual functions.
*
*/
-class CIpsSosAOPopAgent : public CIpsSosAOBaseAgent
+//<Qmail>
+NONSHARABLE_CLASS (CIpsSosAOPopAgent) : public CIpsSosAOBaseAgent
+//</Qmail>
{
public:
@@ -54,35 +56,77 @@
virtual ~CIpsSosAOPopAgent();
public: // from CIpsSosAOBaseAgent
-
+ //<Qmail>
+ /**
+ * GetServerAddress
+ * @param a return parameter
+ */
virtual void GetServerAddress(
TBuf<KIpsSosAOTextBufferSize>& aIncomingServer ) const;
+ /**
+ * GetUsername
+ * @param a return parameter
+ */
virtual void GetUsername(
TBuf8<KIpsSosAOTextBufferSize>& aUsername ) const;
+ /**
+ * checks is does mailbox have connection open
+ * @return is connected or not
+ */
virtual TBool IsConnected() const;
+ /**
+ * Starts email sync
+ */
virtual void StartSyncL();
+ /**
+ * starts fetching messages
+ */
virtual void StartFetchMessagesL( const RArray<TMsvId>& aFetchMsgArray );
+ /**
+ * cancels all ongoing suboperations and disconnects
+ */
virtual void CancelAllAndDisconnectL();
+ /**
+ * cancels all suboperations
+ */
virtual void CancelAllAndDoNotDisconnect();
+ /**
+ * sets iDoNotDisconnect as ETrue
+ */
virtual void DoNotDisconnect();
+ /**
+ * sets iDoNotDisconnect as EFalse
+ */
virtual void ClearDoNotDisconnect();
+ /**
+ * pauses ongoing operations
+ */
virtual void HoldOperations();
+ /**
+ * resumes paused operations
+ */
virtual void ContinueHoldOperations();
+ /**
+ * @return current iState
+ */
virtual CIpsSosAOBaseAgent::TAgentState GetState() const;
+ /**
+ * Loads CImPop3Settings object
+ */
virtual void LoadSettingsL();
-
+ //</Qmail>
private:
/**
@@ -97,17 +141,32 @@
* Second phase constructor
*/
void ConstructL();
-
+ //<Qmail>
+ /**
+ * called when cancelled
+ */
virtual void DoCancel();
+ /**
+ * from CActive
+ */
virtual void RunL();
+ /**
+ * from CActive
+ */
virtual TInt RunError( TInt aError );
+ /**
+ * fetches the content of all synced messages
+ */
void PopulateAllL();
+ /**
+ * triggers async statemachine
+ */
inline void SetActiveAndCompleteThis();
-
+ //</Qmail>
private:
@@ -117,17 +176,19 @@
TBool iSyncStartedSignaled;
TAgentState iState;
TBool iDoNotDisconnect;
- CImPop3Settings* iPopSettings;
- CMsvOperation* iOngoingOp;
+ //<Qmail>
+ CImPop3Settings* iPopSettings;//owned
+ CMsvOperation* iOngoingOp;//owned
TPckgBuf<TPop3Progress> iProgressBuf;
- CMsvEntrySelection* iSelection;
+ CMsvEntrySelection* iSelection;//owned
TInt iError;
- CPop3ClientMtm* iPopClientMtm;
- CClientMtmRegistry* iMtmReg;
+ CPop3ClientMtm* iPopClientMtm;//owned
+ CClientMtmRegistry* iMtmReg;//owned
+ //</Qmail>
TInt iPopulateLimit;
};
-#endif /*IPSSOSAOPOPAGENT_H_*/
+#endif /*IPSSOSAOPOPAGENT_H*/