cmmanager/cmmgr/cmmserver/inc/cmmconnmethodstruct.h
changeset 20 9c97ad6591ae
child 23 7ec726f93df1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cmmanager/cmmgr/cmmserver/inc/cmmconnmethodstruct.h	Mon May 03 12:53:07 2010 +0300
@@ -0,0 +1,147 @@
+/*
+* Copyright (c) 2009-2010 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:
+* Cache side object representing a connection method.
+*
+*/
+
+
+#ifndef CMMCONNMETHODSTRUCT_H_
+#define CMMCONNMETHODSTRUCT_H_
+
+#include <e32base.h>
+
+#include "cmmserverdefs.h"
+
+class CCmmConnMethodInstance;
+class CCmPluginBaseEng;
+
+
+/**
+ * TODO
+ */
+NONSHARABLE_CLASS( CCmmConnMethodStruct ) : public CBase
+    {
+public:
+    static CCmmConnMethodStruct* NewL( const TUint32& aConnMethodId );
+    static CCmmConnMethodStruct* NewLC( const TUint32& aConnMethodId );
+    ~CCmmConnMethodStruct();
+
+private:
+    CCmmConnMethodStruct( TUint32 aConnMethodId );
+    void ConstructL();
+
+public:
+    /**
+     * Return the reference count.
+     */
+    TInt GetReferenceCounter();
+
+    /**
+     * Increase the reference counter by one.
+     */
+    void IncrementReferenceCounter();
+
+    /**
+     * Return the connection method ID.
+     */
+    TUint32 GetId() const;
+
+    /**
+     * Set the connection method ID.
+     */
+    void SetId( const TUint32& aConnMethodId );
+
+    /**
+     * Return bearer type.
+     */
+    TUint32 GetBearerType() const;
+
+    /**
+     * Gets the current status of this connection method struct.
+     */
+    TCmmConnMethodStatus GetStatus() const;
+
+    /**
+     * Sets a new status value.
+     */
+    void SetStatus( const TCmmConnMethodStatus& aStatus );
+
+    /**
+     * TODO
+     * 
+     */
+    void RefreshConnMethodInstanceL(
+            CCmmConnMethodInstance& aConnMethodInstance );
+
+    /**
+     * Decrease the reference counter by one. Return the remaining number of
+     * references.
+     */
+    TInt SessionInstanceClosed(); //TODO, rename to ConnMethodInstanceClosed ?
+
+    /**
+     * Set the connection method plugin. Updates status and sets reference
+     * counter to 1.
+     */
+    void SetPlugin(
+            CCmPluginBaseEng* aPlugin,
+            TUint32 aBearerType,
+            TCmmConnMethodStatus aStatus );
+
+    /**
+     * Returns the connection method plugin.
+     */
+    CCmPluginBaseEng* GetPlugin();
+
+    /**
+     * Called after this connection method has been updated and database
+     * transaction has completed successfully. Sets the internal state of this
+     * connection method structure to reflect the new valid state.
+     */
+    void UpdateSuccessful();
+
+    /**
+     * Called after this connection method has been deleted and database
+     * transaction has completed successfully. Sets the internal state of this
+     * connection method structure to reflect the new deleted state.
+     */
+    void DeleteSuccessful( const TUint32& aNewSecondaryId );
+
+private:
+    // The connection method plugin.
+    CCmPluginBaseEng* iConnMethodPlugin; // Owned.
+
+    // Total number of handles that the clients have to this connection method.
+    TInt iReferenceCounter;
+
+    // Connection method ID.
+    // For new connection methods, while no valid database ID is available,
+    // will be assigned a temporary ID that will have a value above
+    // above KTemporaryIdCounterStart.
+    TUint32 iConnMethodId;
+
+    // Connection method bearer type.
+    TUint32 iBearerType;
+
+    // Current status of this connection method.
+    TCmmConnMethodStatus iStatus;
+
+    //TODO
+    //TCmmRecordStatus iRecordStatus;
+    };
+
+#endif // CMMCONNMETHODSTRUCT_H_
+
+// End of file