epoc32/include/msvsysagentaction.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/msvsysagentaction.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,128 @@
     1.4 +// Copyright (c) 2000-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 +// MsvSysAgentCondAction.H
    1.18 +// 
    1.19 +//
    1.20 +
    1.21 +#ifndef __MSVSYSAGENTCONDACTION_H__
    1.22 +#define	__MSVSYSAGENTCONDACTION_H__
    1.23 +
    1.24 + 
    1.25 +
    1.26 +
    1.27 +#include <msvsenderroraction.h>
    1.28 +
    1.29 +/////////////////////////////////////////////////////////////////////////////
    1.30 +//
    1.31 +//	System Agent-related Class Declarations
    1.32 +//
    1.33 +/////////////////////////////////////////////////////////////////////////////
    1.34 +
    1.35 +
    1.36 +
    1.37 +/** 
    1.38 +Defines a condition which a Publish and Subscribe Uid must satisfy.
    1.39 +
    1.40 +@see RProperty
    1.41 +
    1.42 +@publishedAll
    1.43 +@released
    1.44 +*/
    1.45 +class TMsvCondition
    1.46 +	{
    1.47 +public:
    1.48 +/** 
    1.49 +An enumeration defining the type of test to be made against a Publish 
    1.50 +and Subscribe property. 
    1.51 +*/
    1.52 +	enum TMsvSchSendConditionType
    1.53 +		{
    1.54 +		/** Tests that a value is equal to a state variable value. */
    1.55 +		EMsvSchSendEquals,		
    1.56 +		/** Tests that a value is unequal to a state variable value. */
    1.57 +		EMsvSchSendNotEquals,		
    1.58 +		/** Tests that a value is greater than a state variable value. */
    1.59 +		EMsvSchSendGreaterThan,	
    1.60 +		/** Tests that a value is less than a state variable value. */
    1.61 +		EMsvSchSendLessThan		
    1.62 +		};
    1.63 +		
    1.64 +public:
    1.65 +	/** second UID of the process which set the condition*/
    1.66 +	TUid iVariable;
    1.67 +	/** Integer state of corresponding P&S variable to be tested against*/
    1.68 +	TInt iState;
    1.69 +	/** type of test to be performed */
    1.70 +	TMsvSchSendConditionType iType;
    1.71 +	};
    1.72 +	
    1.73 +
    1.74 +/**
    1.75 +Schedule Send condition must be satisfied before a message sending attempt.
    1.76 +
    1.77 +@publishedAll
    1.78 +@released
    1.79 +*/ 
    1.80 +
    1.81 +class TMsvSysAgentConditionAction
    1.82 +	{
    1.83 +public:
    1.84 +	IMPORT_C TMsvSysAgentConditionAction();
    1.85 +
    1.86 +
    1.87 +	/** Condition to meet. */
    1.88 +	TMsvCondition iCondition;
    1.89 +
    1.90 +	/** Error action to use. */
    1.91 +	TMsvSendErrorAction iErrorAction;
    1.92 +
    1.93 +	/** Default error action. */
    1.94 +	TBool iUseDefaultSysAgentAction;
    1.95 +
    1.96 +private:
    1.97 +	};
    1.98 +
    1.99 +
   1.100 +
   1.101 +/**
   1.102 +Defines an array of  schedule send conditions that must be satisfied before a message sending attempt.
   1.103 +
   1.104 +@see TMsvSysAgentConditionAction
   1.105 +
   1.106 +@publishedAll
   1.107 +@released
   1.108 +*/ 
   1.109 +
   1.110 +class CMsvSysAgentActions : public CArrayFixFlat<TMsvSysAgentConditionAction>
   1.111 +	{
   1.112 +public:
   1.113 +	IMPORT_C CMsvSysAgentActions();
   1.114 +	IMPORT_C ~CMsvSysAgentActions();
   1.115 +
   1.116 +
   1.117 +	IMPORT_C TBool ConditionsMetL(TMsvSendErrorAction& aErrorAction);
   1.118 +
   1.119 +	/** Default send error action. */
   1.120 +	TMsvSendErrorAction iDefault;
   1.121 +
   1.122 +private:
   1.123 +
   1.124 +
   1.125 +	void GetConditionVariablesL(CArrayFix<TUid>& aUids) const;
   1.126 +	TBool CheckStates(const CArrayFix<TInt>& aStates, TMsvSendErrorAction& aErrorAction) const;
   1.127 +	TBool ConditionOK(const TMsvSysAgentConditionAction& aCondAction, const TInt aState) const;
   1.128 +	
   1.129 +	};
   1.130 +
   1.131 +#endif	// __MSVSYSAGENTCONDACTION_H__