epoc32/include/tools/coredump/coredumpinterface.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 // Define the interface to the Core Dump Server
    15 //
    16 
    17 
    18 
    19 /**
    20  @file
    21  @publishedPartner 
    22  @released
    23 */
    24 
    25 #ifndef CORE_DUMP_API_H
    26 #define CORE_DUMP_API_H
    27 
    28 #include <e32base.h>
    29 
    30 
    31 #include <processdata.h>
    32 #include <executabledata.h>
    33 #include <threaddata.h>
    34 #include <coredumpserverapi.h>
    35 #include <optionconfig.h>
    36 
    37 #include <debuglogging.h>
    38 
    39 /**
    40 @publishedPartner
    41 @released
    42 
    43 Definition of the Core Dump Server interface.
    44 This is used by clients to interact with the server.
    45 
    46 */
    47 class RCoreDumpSession	: public RSessionBase
    48 	{
    49         static TInt StartServer();
    50 
    51 	public:		// Construction
    52 		IMPORT_C RCoreDumpSession();
    53 		
    54 	public:
    55 		IMPORT_C TInt Connect();
    56 		IMPORT_C void Disconnect();
    57 
    58 		IMPORT_C void GetPluginListL( RPluginList &aPluginList ) const;
    59 		IMPORT_C void PluginRequestL(const TPluginRequest &aPluginRequest ) const;
    60 
    61         IMPORT_C void GetProcessesL( RProcessPointerList &aProcessList ) const;
    62         IMPORT_C void GetThreadsL( RThreadPointerList &aThreadsList, const TUint64 aPid = (TUint64)-1 ) const;
    63 		IMPORT_C void GetExecutablesL( RExecutablePointerList &aExecutableList ) const;
    64 
    65         IMPORT_C void ObservationRequestL( const TDesC &aTargetName, const TDesC &aTargetOwnerName, TBool aObserve) const;
    66 
    67 		IMPORT_C TInt GetNumberConfigParametersL() const;
    68 		IMPORT_C COptionConfig * GetConfigParameterL( const TInt aIndex ) const;
    69 	    IMPORT_C void SetConfigParameterL( const COptionConfig &aConfig ) const;
    70 
    71 		IMPORT_C void LoadConfigL( const TDesC & aLoadPath ) const;
    72 		IMPORT_C void SaveConfigL( const TDesC & aSavePath ) const;
    73 
    74 	private:	
    75         const TDesC8 &GetListLC(const TListRequest &aRequest) const;
    76 		TVersion Version() const;
    77 
    78 	private:	// Data members
    79 
    80         enum {KConnectionRetries = 3};
    81 
    82 		TBool iConnected;
    83 
    84 		TInt iMaxConfigParamSize;
    85 
    86 		TUint32 iSpare0;
    87 		TUint32 iSpare1;
    88 		TUint32 iSpare2;
    89 		TUint32 iSpare3;
    90 	};
    91 
    92 
    93 #endif // CORE_DUMP_API_H