epoc32/include/tools/coredump/executabledata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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@4
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     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@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// Defines target-executable classes used across the Core Dump client/server interface 
williamr@4
    15
//
williamr@4
    16
williamr@4
    17
williamr@4
    18
williamr@4
    19
/**
williamr@4
    20
 @file
williamr@4
    21
 @publishedPartner 
williamr@4
    22
 @released
williamr@4
    23
*/
williamr@4
    24
williamr@4
    25
#ifndef EXECUTABLEDATA_H
williamr@4
    26
#define EXECUTABLEDATA_H
williamr@4
    27
williamr@4
    28
#include <streamelement.h>
williamr@4
    29
williamr@4
    30
williamr@4
    31
/**
williamr@4
    32
@publishedPartner 
williamr@4
    33
@released
williamr@4
    34
williamr@4
    35
Class that represents a target executable file from which a process can launched. 
williamr@4
    36
It is based on CStreamElementBase so it can be streamed between client and server.
williamr@4
    37
@see CServerCrashDataSource::GetExecutableListL
williamr@4
    38
*/
williamr@4
    39
class CExecutableInfo : public CStreamElementBase
williamr@4
    40
{
williamr@4
    41
williamr@4
    42
public:
williamr@4
    43
williamr@4
    44
	IMPORT_C static CExecutableInfo* NewL( const TDesC		& aName,
williamr@4
    45
										   const TBool  	  aActivelyDebugged,
williamr@4
    46
										   const TBool  	  aPassivelyDebugged );
williamr@4
    47
williamr@4
    48
	IMPORT_C static CExecutableInfo* NewL( const TDesC8 & aStreamData );
williamr@4
    49
williamr@4
    50
	IMPORT_C ~CExecutableInfo();
williamr@4
    51
williamr@4
    52
public:
williamr@4
    53
	// Methods specific to CExecutableInfo
williamr@4
    54
williamr@4
    55
	IMPORT_C void NameL( const TDesC & aName );
williamr@4
    56
	IMPORT_C const TDesC & Name() const;
williamr@4
    57
williamr@4
    58
	IMPORT_C TBool ActivelyDebugged( ) const;
williamr@4
    59
	IMPORT_C void  ActivelyDebugged( TBool aActivelyDebugged );
williamr@4
    60
williamr@4
    61
	IMPORT_C TBool PassivelyDebugged( ) const;
williamr@4
    62
	IMPORT_C void PassivelyDebugged( TBool aPassivelyDebugged );
williamr@4
    63
williamr@4
    64
	IMPORT_C TBool Observed( ) const;
williamr@4
    65
	IMPORT_C void  Observed( TBool aFlag );
williamr@4
    66
williamr@4
    67
williamr@4
    68
public:
williamr@4
    69
	// Methods required by streaming interface 
williamr@4
    70
williamr@4
    71
	IMPORT_C TInt static MaxSize();
williamr@4
    72
williamr@4
    73
	IMPORT_C TInt Size() const;
williamr@4
    74
williamr@4
    75
	// Initializes ’this’ from stream
williamr@4
    76
	IMPORT_C void InternalizeL( RReadStream & aStream );
williamr@4
    77
williamr@4
    78
	// Writes ’this’ to the stream
williamr@4
    79
	IMPORT_C void ExternalizeL( RWriteStream & aStream, CBufFlat* buf );
williamr@4
    80
williamr@4
    81
williamr@4
    82
private:
williamr@4
    83
williamr@4
    84
	CExecutableInfo( const TBool aActivelyDebugged,
williamr@4
    85
					 const TBool aPassivelyDebugged );
williamr@4
    86
williamr@4
    87
	CExecutableInfo();
williamr@4
    88
williamr@4
    89
	void ConstructL( const TDesC & aName );
williamr@4
    90
williamr@4
    91
private:
williamr@4
    92
williamr@4
    93
	/** Symbian kernel executable name */
williamr@4
    94
	HBufC  *			iName;
williamr@4
    95
williamr@4
    96
    /** Actively debugged by client of Debug Security Server */
williamr@4
    97
	TBool				iActivelyDebugged;
williamr@4
    98
williamr@4
    99
    /** Passively debugged by client of Debug Security Server */
williamr@4
   100
	TBool				iPassivelyDebugged;
williamr@4
   101
williamr@4
   102
    /** Observed by core dump server */
williamr@4
   103
	TBool				iObserved;
williamr@4
   104
williamr@4
   105
	/** Externalized size */
williamr@4
   106
	TUint				iSize;
williamr@4
   107
williamr@4
   108
	// These are not internalised/externalised since they are spare
williamr@4
   109
	TUint32				iSpare1;
williamr@4
   110
	TUint32				iSpare2;
williamr@4
   111
	TUint32				iSpare3;
williamr@4
   112
	};
williamr@4
   113
williamr@4
   114
williamr@4
   115
/**
williamr@4
   116
@publishedPartner 
williamr@4
   117
@released
williamr@4
   118
williamr@4
   119
List of CExecutableInfo object pointers
williamr@4
   120
@see CExecutableInfo
williamr@4
   121
@see RPointerArray
williamr@4
   122
*/
williamr@4
   123
typedef RPointerArray<CExecutableInfo>	RExecutablePointerList;
williamr@4
   124
williamr@4
   125
#endif