epoc32/include/logcli.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    30 
    30 
    31 //**********************************
    31 //**********************************
    32 // CLogEventType
    32 // CLogEventType
    33 //**********************************
    33 //**********************************
    34 
    34 
    35 class CLogEventType : public CBase
       
    36 /** Encapsulates the details of an event type.
    35 /** Encapsulates the details of an event type.
    37 
    36 
    38 An event type is used to associate an event with a user-readable description 
    37 An event type is used to associate an event with a user-readable description 
    39 and other configuration information related to the event.
    38 and other configuration information related to the event.
    40 
    39 
    43 @see CLogEvent::EventType()
    42 @see CLogEvent::EventType()
    44 @see CLogEvent::SetEventType()
    43 @see CLogEvent::SetEventType()
    45 @publishedAll 
    44 @publishedAll 
    46 @released
    45 @released
    47 */
    46 */
       
    47 class CLogEventType : public CBase
    48 	{
    48 	{
    49 public:
    49 public:
    50 	IMPORT_C static CLogEventType* NewL();
    50 	IMPORT_C static CLogEventType* NewL();
    51 	IMPORT_C ~CLogEventType();
    51 	IMPORT_C ~CLogEventType();
    52 	//
    52 	//
    78 
    78 
    79 //**********************************
    79 //**********************************
    80 // TLogConfig
    80 // TLogConfig
    81 //**********************************
    81 //**********************************
    82 
    82 
    83 class TLogConfig
       
    84 /** Encapsulates Log Engine configuration data.
    83 /** Encapsulates Log Engine configuration data.
    85 
    84 
    86 @see CLogClient::GetConfig()
    85 @see CLogClient::GetConfig()
    87 @see CLogClient::ChangeConfig()
    86 @see CLogClient::ChangeConfig()
    88 @publishedAll
    87 @publishedAll
    89 @released
    88 @released
    90 */
    89 */
       
    90 class TLogConfig
    91 	{
    91 	{
    92 public:
    92 public:
    93 	IMPORT_C TLogConfig();
    93 	IMPORT_C TLogConfig();
    94 	//
    94 	//
    95 	void InternalizeL(RReadStream& aStream);
    95 	void InternalizeL(RReadStream& aStream);
   119 
   119 
   120 //**********************************
   120 //**********************************
   121 // CLogFilter
   121 // CLogFilter
   122 //**********************************
   122 //**********************************
   123 
   123 
   124 class CLogFilter : public CBase
       
   125 /** Specifies the conditions that events must satisfy to appear in a view.
   124 /** Specifies the conditions that events must satisfy to appear in a view.
   126 
   125 
   127 In general, a filter is used to construct the WHERE clause of an SQL 
   126 In general, a filter is used to construct the WHERE clause of an SQL 
   128 statement based on the content of the filter's fields. The filter's fields 
   127 statement based on the content of the filter's fields. The filter's fields 
   129 correspond to the event properties in a log event detail object, i.e. an instance 
   128 correspond to the event properties in a log event detail object, i.e. an instance 
   137 @see CLogViewRecent
   136 @see CLogViewRecent
   138 @see CLogViewDuplicate
   137 @see CLogViewDuplicate
   139 @publishedAll
   138 @publishedAll
   140 @released
   139 @released
   141 */
   140 */
       
   141 class CLogFilter : public CBase
   142 	{
   142 	{
   143 public:
   143 public:
   144 	IMPORT_C static CLogFilter* NewL();
   144 	IMPORT_C static CLogFilter* NewL();
   145 	IMPORT_C ~CLogFilter();
   145 	IMPORT_C ~CLogFilter();
   146 	//
   146 	//
   180 	inline void SetEndTime(const TTime& aEndTime);
   180 	inline void SetEndTime(const TTime& aEndTime);
   181 	//
   181 	//
   182 	IMPORT_C void Copy(const CLogFilter& aFilter);
   182 	IMPORT_C void Copy(const CLogFilter& aFilter);
   183 	void InternalizeL(RReadStream& aStream);
   183 	void InternalizeL(RReadStream& aStream);
   184 	void ExternalizeL(RWriteStream& aStream) const;
   184 	void ExternalizeL(RWriteStream& aStream) const;
       
   185 	//
       
   186 	IMPORT_C void SetSimId(TSimId aSimId);
       
   187 	IMPORT_C TSimId SimId() const;
   185 	//
   188 	//
   186 private:
   189 private:
   187 	CLogFilter();
   190 	CLogFilter();
   188 	void ConstructL();
   191 	void ConstructL();
   189 	void InternalizeBufL(RReadStream& aStream, HBufC*& aDes);
   192 	void InternalizeBufL(RReadStream& aStream, HBufC*& aDes);
   198 	HBufC* iNumber;
   201 	HBufC* iNumber;
   199 	TLogFlags iFlags;
   202 	TLogFlags iFlags;
   200 	TUint32 iNullFields;
   203 	TUint32 iNullFields;
   201 	TTime iStartTime;
   204 	TTime iStartTime;
   202 	TTime iEndTime;
   205 	TTime iEndTime;
   203 	};
   206 #ifdef SYMBIAN_ENABLE_EVENTLOGGER_DUALSIM
   204 
   207 	TSimId iSimId;
   205 class CLogFilterList : public CArrayPtrFlat<const CLogFilter>
   208 #endif
       
   209 	};
       
   210 
   206 /** A set of event view filters.
   211 /** A set of event view filters.
   207 
   212 
   208 Specifically, this is an array of pointers to const CLogFilter objects and 
   213 Specifically, this is an array of pointers to const CLogFilter objects and 
   209 is derived from CArrayPtrFlat<const CLogFilter>.
   214 is derived from CArrayPtrFlat<const CLogFilter>.
   210 
   215 
   212 @see CLogViewEvent
   217 @see CLogViewEvent
   213 @see CLogViewRecent
   218 @see CLogViewRecent
   214 @publishedAll
   219 @publishedAll
   215 @released
   220 @released
   216 */
   221 */
       
   222 class CLogFilterList : public CArrayPtrFlat<const CLogFilter>
   217 	{
   223 	{
   218 public:
   224 public:
   219 	IMPORT_C CLogFilterList();
   225 	IMPORT_C CLogFilterList();
   220 	IMPORT_C CLogFilterList* CopyL() const;
   226 	IMPORT_C CLogFilterList* CopyL() const;
   221 	IMPORT_C CLogFilterList* CopyLC() const;
   227 	IMPORT_C CLogFilterList* CopyLC() const;
   241 class CLogGetConfigClientOp;
   247 class CLogGetConfigClientOp;
   242 class CLogChangeConfigClientOp;
   248 class CLogChangeConfigClientOp;
   243 class CLogClearLogClientOp;
   249 class CLogClearLogClientOp;
   244 class CLogClearRecentClientOp;
   250 class CLogClearRecentClientOp;
   245 
   251 
   246 class CLogClient : public CLogBase
       
   247 /** Log Engine implementation.
   252 /** Log Engine implementation.
   248 
   253 
   249 It creates a shared session on the log database and allows log viewers to 
   254 It creates a shared session on the log database and allows log viewers to 
   250 retrieve events from the log.
   255 retrieve events from the log.
   251 
   256 
   256 
   261 
   257 @see CLogWrapper
   262 @see CLogWrapper
   258 @publishedAll
   263 @publishedAll
   259 @released
   264 @released
   260 */
   265 */
       
   266 class CLogClient : public CLogBase
   261 	{
   267 	{
   262 public:
   268 public:
   263 	IMPORT_C static CLogClient* NewL(RFs& aFs, TInt aPriority = CActive::EPriorityStandard);
   269 	IMPORT_C static CLogClient* NewL(RFs& aFs, TInt aPriority = CActive::EPriorityStandard);
   264 	IMPORT_C ~CLogClient();
   270 	IMPORT_C ~CLogClient();
   265 	//
   271 	//
   275 	IMPORT_C void DeleteEventType(TUid aId, TRequestStatus& aStatus);
   281 	IMPORT_C void DeleteEventType(TUid aId, TRequestStatus& aStatus);
   276 	IMPORT_C void GetConfig(TLogConfig& aConfig, TRequestStatus& aStatus);
   282 	IMPORT_C void GetConfig(TLogConfig& aConfig, TRequestStatus& aStatus);
   277 	IMPORT_C void ChangeConfig(const TLogConfig& aConfig, TRequestStatus& aStatus);
   283 	IMPORT_C void ChangeConfig(const TLogConfig& aConfig, TRequestStatus& aStatus);
   278 	IMPORT_C void ClearLog(const TTime& aDate, TRequestStatus& aStatus);
   284 	IMPORT_C void ClearLog(const TTime& aDate, TRequestStatus& aStatus);
   279 	IMPORT_C void ClearLog(TInt aRecentList, TRequestStatus& aStatus);
   285 	IMPORT_C void ClearLog(TInt aRecentList, TRequestStatus& aStatus);
       
   286 	IMPORT_C void ClearLog(const TTime& aDate, TSimId aSimid, TRequestStatus& aStatus);
       
   287 	IMPORT_C void ClearLog(TInt aRecentList, TSimId aSimid, TRequestStatus& aStatus);
   280 	//
   288 	//
   281 	IMPORT_C void NotifyChange(TTimeIntervalMicroSeconds32 aDelay, TRequestStatus& aStatus);
   289 	IMPORT_C void NotifyChange(TTimeIntervalMicroSeconds32 aDelay, TRequestStatus& aStatus);
   282 	IMPORT_C void NotifyChangeCancel();
   290 	IMPORT_C void NotifyChangeCancel();
   283 	//
   291 	//
   284 	IMPORT_C void SetGlobalChangeObserverL(MLogClientChangeObserver* aObserver);
   292 	IMPORT_C void SetGlobalChangeObserverL(MLogClientChangeObserver* aObserver);