epoc32/include/smsulog.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1998-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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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
//
williamr@2
    15
williamr@2
    16
/**
williamr@2
    17
 @file
williamr@2
    18
*/
williamr@2
    19
williamr@2
    20
#if !defined (__SMSULOG_H__)
williamr@2
    21
#define __SMSULOG_H__
williamr@2
    22
williamr@2
    23
#include <e32base.h>
williamr@2
    24
#include <logwrap.h>
williamr@2
    25
#include <e32std.h>
williamr@2
    26
#include "smsuact.h"
williamr@4
    27
#include <logsmspdudata.h>
williamr@2
    28
williamr@2
    29
class RFs;
williamr@2
    30
class CSmsMessage;
williamr@2
    31
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
 *  Logs SMS-related events.
williamr@2
    35
 *  
williamr@2
    36
 *  The class uses the log engine functionality provided by the Log Engine (CLogWrapper
williamr@2
    37
 *  etc.).
williamr@2
    38
 *  
williamr@2
    39
 *  @publishedAll
williamr@2
    40
 *  @released 
williamr@2
    41
 */
williamr@2
    42
class CSmsEventLogger : public CSmsuActiveBase
williamr@2
    43
	{
williamr@2
    44
public:
williamr@2
    45
	IMPORT_C static CSmsEventLogger* NewL(RFs& aFs,TInt aPriority=CActive::EPriorityStandard);
williamr@2
    46
	IMPORT_C ~CSmsEventLogger();
williamr@2
    47
williamr@2
    48
	IMPORT_C void AddEvent(TRequestStatus& aStatus,const CSmsMessage& aSmsMessage,const TLogSmsPduData& aData,TInt* aStatusId=NULL);
williamr@2
    49
	IMPORT_C void GetEvent(TRequestStatus& aStatus,TLogId aId);
williamr@2
    50
	IMPORT_C void ChangeEvent(TRequestStatus& aStatus,const CSmsMessage& aSmsMessage,const TLogSmsPduData& aData,TInt* aStatusId=NULL);
williamr@4
    51
    IMPORT_C void ChangeEvent(TRequestStatus& aStatus,const CSmsMessage& aSmsMessage, const TTime* aTime, const TLogSmsPduData& aData, TInt* aStatusId=NULL);	
williamr@2
    52
	IMPORT_C void DeleteEvent(TRequestStatus& aStatus);
williamr@2
    53
williamr@2
    54
	inline TBool ClientAvailable() const;
williamr@2
    55
	inline TInt GetString(TDes& aString,TInt aId) const;
williamr@2
    56
	inline CLogEvent& Event();
williamr@2
    57
	inline const CLogEvent& Event() const;
williamr@2
    58
	inline const TLogSmsPduData& SmsPDUData() const;
williamr@2
    59
williamr@2
    60
protected:
williamr@2
    61
williamr@2
    62
	void DoCancel();
williamr@2
    63
williamr@2
    64
private:
williamr@2
    65
	CSmsEventLogger(TInt aPriority);
williamr@2
    66
	void ConstructL(RFs& aFs);
williamr@2
    67
	void DoRunL();
williamr@2
    68
	void DoAddEventL(const CSmsMessage& aSmsMessage,TInt* aStatusId);
williamr@2
    69
    void SetDataL(const CSmsMessage& aSmsMessage,TInt* aStatusId, const TTime* aDischargeTime);
williamr@2
    70
	void DoComplete(TInt& aStatus);
williamr@2
    71
	inline void GetStringL(TDes& aString,TInt aId) const;
williamr@2
    72
williamr@2
    73
private:
williamr@2
    74
	enum TSmsEventLoggerState
williamr@2
    75
		{
williamr@2
    76
		ESmsEventLoggerIdle,
williamr@2
    77
		ESmsEventLoggerGettingEvent,
williamr@2
    78
		ESmsEventLoggerAddingEvent,
williamr@2
    79
		ESmsEventLoggerChangingEvent,
williamr@2
    80
		ESmsEventLoggerDeletingEvent
williamr@2
    81
		};
williamr@2
    82
private:
williamr@2
    83
	TSmsEventLoggerState iState;
williamr@2
    84
williamr@2
    85
	CLogWrapper* iLogWrapper;
williamr@2
    86
	CLogEvent* iLogEvent;
williamr@2
    87
williamr@2
    88
	TLogSmsPduData iSmsPDUData;
williamr@2
    89
	};
williamr@2
    90
williamr@2
    91
#include "smsulog.inl"
williamr@2
    92
williamr@2
    93
#endif