os/ossrv/lowlevellibsandfws/pluginfw/Framework/DiscovererTest/DiscovererObserverStub.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/DiscovererTest/DiscovererObserverStub.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,213 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Implementation of the stub class for the Discoverer tests
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __DISCOVEREROBSERVERSTUB_H__
1.22 +#define __DISCOVEREROBSERVERSTUB_H__
1.23 +
1.24 +#include "DiscovererObserver.h"
1.25 +#include "DiscovererStateAccessor.h"
1.26 +#include "DiscovererTransitions.h"
1.27 +
1.28 +// ______________________________________________________________________________
1.29 +//
1.30 +/**
1.31 + @internalComponent
1.32 + @since 7.0
1.33 + This class is intended to provide the stub functionality of the
1.34 + CDiscoverers observer class. The methods will be used to log the
1.35 + calls that CDiscoverer is making to its observer.
1.36 + Note that the calls do not return any error codes, and so there
1.37 + is no requirement to repeat a transition, exercising the various
1.38 + control paths of the stub caller.
1.39 + RegisterDiscoveryL, and DriveReinstatedL can leave however,
1.40 + and there will be a repeat call on the transition that call
1.41 + these stub methods to exercise the alternative
1.42 + control paths of the caller.
1.43 + In the actual ECom implementation MDiscovererObserver is inherited
1.44 + privately but this causes problems with casting the stub so it is
1.45 + public here.
1.46 + */
1.47 +class CObserverStub : public CBase, public MDiscovererObserver
1.48 +{
1.49 +public:
1.50 + /**
1.51 + @fn CObserverStub* NewL(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext)
1.52 + Intended Usage : Standardised safe construction which leaves nothing the cleanup stack.
1.53 + Error Condition : Leaves with the error code.
1.54 + @leave KErrNoMemory.
1.55 + @since 7.0
1.56 + @param CUnitTest& aOwner" "
1.57 + @return CObserverStub*
1.58 + @pre None
1.59 + @post CObserverStub is fully constructed and initialised.
1.60 + */
1.61 + static CObserverStub* NewL(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext);
1.62 +
1.63 + /**
1.64 + @fn CObserverStub* NewLC(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext)
1.65 + Intended Usage : Standardised safe construction which leaves CObserverStub* upon the cleanup stack.
1.66 + Error Condition : Leaves with the error code.
1.67 + @leave KErrNoMemory.
1.68 + @since 7.0
1.69 + @param CUnitTest& aOwner" "
1.70 + @return CObserverStub*
1.71 + @pre None
1.72 + @post CObserverStub is fully constructed and initialised, and remains on the cleanup stack.
1.73 + */
1.74 + static CObserverStub* NewLC(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext);
1.75 +
1.76 + /**
1.77 + @fn CObserverStub::~CObserverStub()
1.78 + Intended Usage : Default Destructor
1.79 + @since 7.0
1.80 + @pre CObserverStub is fully constructed
1.81 + @post CObserverStub is fully destroyed
1.82 + */
1.83 + virtual ~CObserverStub();
1.84 +
1.85 + // Observer methods requiring overload
1.86 + /**
1.87 + @fn DiscoveriesBegin()
1.88 + Intended Usage : Overload of the MDiscovererObserver callback method.
1.89 + to signal that a discovery session is starting.
1.90 + Error Condition : None.
1.91 + @since 7.0
1.92 + @return None.
1.93 + @pre The MDiscovererObserver must be fully constructed, and
1.94 + capable of accepting discoveries for registration.
1.95 + @post Discovery start is noted, and any appropriate action
1.96 + for the observer is completed.
1.97 + */
1.98 + virtual void DiscoveriesBegin();
1.99 +
1.100 + /**
1.101 + @fn RegisterDiscoveryL(const TEntry& aDirEntry)
1.102 + Intended Usage : Overload of the MDiscovererObserver callback method.
1.103 + to register a discovery.
1.104 + Error Condition : Depends upon the implementation class.
1.105 + @leave Implementation class dependent. @see CRegistrar.
1.106 + @since 7.0
1.107 + @param aDirEntry A reference to the Discovered directory entry.
1.108 + @return None.
1.109 + @pre The MDiscovererObserver must be fully constructed, and
1.110 + capable of accepting discoveries for registration.
1.111 + @post Discovery is registered.
1.112 + */
1.113 + virtual void RegisterDiscoveryL(const TEntry& aDirEntry);
1.114 +
1.115 + /**
1.116 + @fn DiscoveriesComplete(TBool aSuccessful)
1.117 + Intended Usage : Overload of the MDiscovererObserver callback method.
1.118 + to signal that a discovery session is complete.
1.119 + Error Condition : None.
1.120 + @since 7.0
1.121 + @param aSuccessful ETrue indicates the scan completed successfully,
1.122 + EFalse, that the scan was only partial.
1.123 + @return None.
1.124 + @pre The MDiscovererObserver must be fully constructed, and
1.125 + capable of accepting discoveries for registration.
1.126 + @post Discovery completion is noted, and any appropriate action
1.127 + for the observer is completed.
1.128 + */
1.129 + virtual void DiscoveriesComplete(TBool aSuccessful);
1.130 +
1.131 + /**
1.132 + @fn DriveRemovedL(TDriveUnit aDrive)
1.133 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.134 + to notify the observer that a drive letter
1.135 + is no longer available for use.
1.136 + Error Condition : None.
1.137 + @since 7.0 :
1.138 + @param aDrive The drive identifier.
1.139 + @pre The MDiscovererObserver must be fully constructed, and
1.140 + capable of accepting discoveries for registration.
1.141 + @post Drive removal is noted, and any appropriate action
1.142 + for the observer is completed.
1.143 + E.g. The registered implementation groupings
1.144 + stored upon the specified drive are no
1.145 + longer available for use.
1.146 + */
1.147 + virtual void DriveRemovedL(TDriveUnit aDrive);
1.148 +
1.149 + /**
1.150 + @fn DriveReinstatedL(TDriveUnit aDrive)
1.151 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.152 + to notify the observer that a drive letter
1.153 + has become available for use.
1.154 + Error Condition : None.
1.155 + @since 7.0 :
1.156 + @param aDrive The drive identifier.
1.157 + @pre The MDiscovererObserver must be fully constructed, and
1.158 + capable of accepting discoveries for registration.
1.159 + @post Drive removal is noted, and any appropriate action
1.160 + for the observer is completed.
1.161 + E.g. The registered implementation groupings
1.162 + stored upon the specified drive are again
1.163 + made available for use.
1.164 + */
1.165 + virtual void DriveReinstatedL(TDriveUnit aDrive);
1.166 +
1.167 + /**
1.168 + @fn NotifiedWithErrorCode(TInt aError)
1.169 + Intended Usage :Overload of the MDiscovererObserver callback method.
1.170 + The notification that the notifier has been activated
1.171 + with an error status code. The observer should instruct
1.172 + the notification object how to proceed.
1.173 + Error Condition : None.
1.174 + @since 7.0 :
1.175 + @param aError The error value recieved by the notifier.
1.176 + @return ETrue for ignore error, EFalse otherwise.
1.177 + @pre CRegistrar is fully constructed.
1.178 + @post The status code should be used by the observer to instruct
1.179 + the notifier to cease recieving notifications or not.
1.180 + */
1.181 + virtual TBool NotifiedWithErrorCode(TInt aError);
1.182 +
1.183 +private:
1.184 + /**
1.185 + @fn CObserverStub::CObserverStub(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext)
1.186 + Intended Usage : Default Constructor : usable only by derived classes
1.187 + @since 7.0
1.188 + @param CUnitTest& A reference to the owning CUnitTest
1.189 + @return None
1.190 + @pre None
1.191 + @post CObserverStub is fully constructed
1.192 + */
1.193 + CObserverStub(CUnitTest& aOwner, CDiscoverer_UnitTestContext& aContext);
1.194 +
1.195 + /**
1.196 + @fn void CObserverStub::ConstructL()
1.197 + Intended Usage : Completes the safe construction of the CObserverStub object
1.198 + Error Condition : Leaves with the error code.
1.199 + @leave KErrNoMemory.
1.200 + @since 7.0
1.201 + @return None
1.202 + @pre CObserverStub is fully constructed
1.203 + @post CObserverStub is fully initialised
1.204 + */
1.205 + void ConstructL();
1.206 +
1.207 +// Attributes / Properties
1.208 +private:
1.209 + /** A reference to the owning CUnitTest */
1.210 + CUnitTest& iOwner;
1.211 + /** A reference to the Unit Test context object */
1.212 + CDiscoverer_UnitTestContext& iContext;
1.213 +}; // End of CObserverStub definition
1.214 +
1.215 +
1.216 +#endif // __DISCOVEREROBSERVERSTUB_H__