epoc32/include/msvsysagentaction.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// MsvSysAgentCondAction.H
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __MSVSYSAGENTCONDACTION_H__
williamr@2
    19
#define	__MSVSYSAGENTCONDACTION_H__
williamr@2
    20
williamr@2
    21
 
williamr@2
    22
williamr@2
    23
williamr@2
    24
#include <msvsenderroraction.h>
williamr@2
    25
williamr@2
    26
/////////////////////////////////////////////////////////////////////////////
williamr@2
    27
//
williamr@2
    28
//	System Agent-related Class Declarations
williamr@2
    29
//
williamr@2
    30
/////////////////////////////////////////////////////////////////////////////
williamr@2
    31
williamr@2
    32
williamr@2
    33
williamr@2
    34
/** 
williamr@2
    35
Defines a condition which a Publish and Subscribe Uid must satisfy.
williamr@2
    36
williamr@2
    37
@see RProperty
williamr@2
    38
williamr@2
    39
@publishedAll
williamr@2
    40
@released
williamr@2
    41
*/
williamr@2
    42
class TMsvCondition
williamr@2
    43
	{
williamr@2
    44
public:
williamr@2
    45
/** 
williamr@2
    46
An enumeration defining the type of test to be made against a Publish 
williamr@2
    47
and Subscribe property. 
williamr@2
    48
*/
williamr@2
    49
	enum TMsvSchSendConditionType
williamr@2
    50
		{
williamr@2
    51
		/** Tests that a value is equal to a state variable value. */
williamr@2
    52
		EMsvSchSendEquals,		
williamr@2
    53
		/** Tests that a value is unequal to a state variable value. */
williamr@2
    54
		EMsvSchSendNotEquals,		
williamr@2
    55
		/** Tests that a value is greater than a state variable value. */
williamr@2
    56
		EMsvSchSendGreaterThan,	
williamr@2
    57
		/** Tests that a value is less than a state variable value. */
williamr@2
    58
		EMsvSchSendLessThan		
williamr@2
    59
		};
williamr@2
    60
		
williamr@2
    61
public:
williamr@2
    62
	/** second UID of the process which set the condition*/
williamr@2
    63
	TUid iVariable;
williamr@2
    64
	/** Integer state of corresponding P&S variable to be tested against*/
williamr@2
    65
	TInt iState;
williamr@2
    66
	/** type of test to be performed */
williamr@2
    67
	TMsvSchSendConditionType iType;
williamr@2
    68
	};
williamr@2
    69
	
williamr@2
    70
williamr@2
    71
/**
williamr@2
    72
Schedule Send condition must be satisfied before a message sending attempt.
williamr@2
    73
williamr@2
    74
@publishedAll
williamr@2
    75
@released
williamr@2
    76
*/ 
williamr@2
    77
williamr@2
    78
class TMsvSysAgentConditionAction
williamr@2
    79
	{
williamr@2
    80
public:
williamr@2
    81
	IMPORT_C TMsvSysAgentConditionAction();
williamr@2
    82
williamr@2
    83
williamr@2
    84
	/** Condition to meet. */
williamr@2
    85
	TMsvCondition iCondition;
williamr@2
    86
williamr@2
    87
	/** Error action to use. */
williamr@2
    88
	TMsvSendErrorAction iErrorAction;
williamr@2
    89
williamr@2
    90
	/** Default error action. */
williamr@2
    91
	TBool iUseDefaultSysAgentAction;
williamr@2
    92
williamr@2
    93
private:
williamr@2
    94
	};
williamr@2
    95
williamr@2
    96
williamr@2
    97
williamr@2
    98
/**
williamr@2
    99
Defines an array of  schedule send conditions that must be satisfied before a message sending attempt.
williamr@2
   100
williamr@2
   101
@see TMsvSysAgentConditionAction
williamr@2
   102
williamr@2
   103
@publishedAll
williamr@2
   104
@released
williamr@2
   105
*/ 
williamr@2
   106
williamr@2
   107
class CMsvSysAgentActions : public CArrayFixFlat<TMsvSysAgentConditionAction>
williamr@2
   108
	{
williamr@2
   109
public:
williamr@2
   110
	IMPORT_C CMsvSysAgentActions();
williamr@2
   111
	IMPORT_C ~CMsvSysAgentActions();
williamr@2
   112
williamr@2
   113
williamr@2
   114
	IMPORT_C TBool ConditionsMetL(TMsvSendErrorAction& aErrorAction);
williamr@2
   115
williamr@2
   116
	/** Default send error action. */
williamr@2
   117
	TMsvSendErrorAction iDefault;
williamr@2
   118
williamr@2
   119
private:
williamr@2
   120
williamr@2
   121
williamr@2
   122
	void GetConditionVariablesL(CArrayFix<TUid>& aUids) const;
williamr@2
   123
	TBool CheckStates(const CArrayFix<TInt>& aStates, TMsvSendErrorAction& aErrorAction) const;
williamr@2
   124
	TBool ConditionOK(const TMsvSysAgentConditionAction& aCondAction, const TInt aState) const;
williamr@2
   125
	
williamr@2
   126
	};
williamr@2
   127
williamr@2
   128
#endif	// __MSVSYSAGENTCONDACTION_H__