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