Interface access: | publishedPartner | |
class RCoreDumpSession : public RSessionBase;
Description
Definition of the Core Dump Server interface. This is used by clients to interact with the server.
Derivation
RSessionBase
- No description.RCoreDumpSession
- Definition of the Core Dump Server interface. This is used by clients to interac...
Members
Defined in RCoreDumpSession
More...
Construction and destruction
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C RCoreDumpSession();
Description
Constructor. It initializes the member variables to zero.
Interface access: | internal to technology | Default as private. |
private: static TInt StartServer();
Description
Called to start the server (by the RCoreDumpSession::Connect()
) The function is only called if the server is not running.
Return value
TInt |
KErrNone if server was successfully started, or one of the other system wide error codes |
|
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C TInt Connect();
Description
First call that a client must make to use the Core Dump server. This call starts the server if not already running, and then connects to it.
Return value
TInt |
KErrNone if connection was successfully created, or one of the other system wide error codes |
|
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void Disconnect();
Description
Required to be called to close the session with the CoreDumpServer. It automatically closes this session handle.
GetPluginListL(RPluginList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetPluginListL(RPluginList &aPluginList) const;
Description
Provides the caller with a list of currently available formatter and writer plugins.
Parameters
RPluginList &aPluginList |
reference to list to be filled with TPluginInfo structs. The caller takes ownership of the content. |
|
PluginRequestL(const TPluginRequest &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void PluginRequestL(const TPluginRequest &aPluginRequest) const;
Description
Make a request to load/unload a plugin.
Parameters
const TPluginRequest &aPluginRequest |
Structure defining the plugin request |
|
See also:
TPluginRequest
Class used between Core Dump Server and its clients to request the server to car...
GetProcessesL(RProcessPointerList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetProcessesL(RProcessPointerList &aProcessList) const;
Description
Provides the caller with a list of the currently running processes.
Parameters
RProcessPointerList &aProcessList |
Reference to the pointer list that is going to be filled with CProcessInfo objects. The caller takes ownership of the content. |
|
GetThreadsL(RThreadPointerList &,const TUint64)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetThreadsL(RThreadPointerList &aThreadsList, const TUint64 aPid=(TUint64)-1) const;
Description
Provides the caller with a list of currently running threads.
Parameters
RThreadPointerList &aThreadsList |
reference to the pointer list that is going to be filled with CThreadInfo objects. The caller takes ownership of the content. |
const TUint64 aPid |
Specify this to narrow the list of threads to a particular process. |
|
GetExecutablesL(RExecutablePointerList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetExecutablesL(RExecutablePointerList &aExecutableList) const;
Description
Provides the caller with a list of executables.
Parameters
ObservationRequestL(const TDesC &,const TDesC &,TBool)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void ObservationRequestL(const TDesC &aTargetName, const TDesC &aTargetOwnerName, TBool aObserve) const;
Description
Request the observation of a thread or process. To observe a process, aTargetName and aTargetOwnerName must be the same and be the name of the process. To observe a thread, aTargetOwnerName is the name of the process and aTargetName is the name To observe an executable, aTargetOwnerName is the full path to the exe and aTargetName is also the full path to the exe of the thread.
Parameters
const TDesC &aTargetName |
Name of process or thread |
const TDesC &aTargetOwnerName |
Name of process |
TBool aObserve |
Set to ETrue to request the observation of the target. EFalse to stop observing the target. |
|
See also:
GetNumberConfigParametersL()const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C TInt GetNumberConfigParametersL() const;
Description
Return the total list of configuration parameters currently available. The list is made up of the parameters from the Core Dump Server and any loaded plugins.
Return value
See also:
COptionConfig
Class that represents a configuration parameter. It is based on CStreamElementBa...
GetConfigParameterL(const TInt)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C COptionConfig* GetConfigParameterL(const TInt aIndex) const;
Description
Obtain the configuration parameter indexed by aIndex.
Parameters
Return value
See also:
COptionConfig
Class that represents a configuration parameter. It is based on CStreamElementBa...
SetConfigParameterL(const COptionConfig &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void SetConfigParameterL(const COptionConfig &aConfig) const;
Description
Change a configuration parameter.
Parameters
const COptionConfig &aConfig |
The modified parameter that will be changed. The index and source are checked against those held by the server. |
|
LoadConfigL(const TDesC &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void LoadConfigL(const TDesC &aLoadPath) const;
Description
Restore a configuration. Configuration files are created by the Core dump server when it exits and when the call SaveConfigL is made. The format is private and should be considered binary. When the Core dump server exits it stores the current configuration in its private directory with the name coredumpserver.ini.
Parameters
const TDesC &aLoadPath |
File that will be read and restored |
|
SaveConfigL(const TDesC &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void SaveConfigL(const TDesC &aSavePath) const;
Description
Save the current configuration to file.
Parameters
const TDesC &aSavePath |
File that will be saved |
|
GetFormattersL(RPluginPointerList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetFormattersL(RPluginPointerList &aFormatterList) const;
Description
Parameters
RPluginPointerList &aFormatterList |
Reference to the pointer list that is going to be filled with CPluginInfo objects. The caller takes ownership of the content. |
|
GetWritersL(RPluginPointerList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void GetWritersL(RPluginPointerList &aWriterList) const;
Description
Parameters
ListCrashesInFlashL(RCrashInfoPointerList &)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void ListCrashesInFlashL(RCrashInfoPointerList &aCrashes) const;
Description
Lists the crashes in the flash partition
Parameters
Leave codes
DeleteCrashLogL(TInt)const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void DeleteCrashLogL(TInt aCrashId) const;
Description
Deletes crash log specified from the flash partition
Parameters
TInt aCrashId |
Identifier of crash to delete |
|
Leave codes
DeleteCrashPartitionL()const
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void DeleteCrashPartitionL() const;
Description
Deletes crash partition from the flash partition
Leave codes
ProcessCrashLogL(const TInt)
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void ProcessCrashLogL(const TInt aCrashId);
Description
Processes the crash log in the flash partition corrosponding to the crash ID of this TCrashInfo
object. If this doesnt match a crash in the partition, or the flash cannot be read this will leave with KErrCorrupted
Parameters
Leave codes
ProcessCrashLog(TInt,TRequestStatus &)
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C void ProcessCrashLog(TInt aCrashId, TRequestStatus &aStatus);
Description
Processes the crash log Asynchronously in the flash partition corresponding to the crash ID of this TCrashInfo
object.
Parameters
TInt aCrashId |
The crash to be processed |
TRequestStatus &aStatus |
asynchronous request status object |
|
CancelProcessCrashLog(TInt)
Interface access: | publishedPartner | Inherited from: RCoreDumpSession |
IMPORT_C TInt CancelProcessCrashLog(TInt aCrashId);
Description
Cancel a previously issued asynchronous RCoreDumpSession::ProcessCrashLog(TInt,TRequestStatus &)
call
Parameters
Return value
TInt |
Any error which may be returned by RSessionBase::SendReceive() |
|
GetListLC(const TListRequest &)const
Interface access: | internal to technology | Default as private. |
private: const TDesC8& GetListLC(const TListRequest &aRequest) const;
Description
Called by GetProcessesL and GetThreadsL methods to get list information from the CoreDumpServer.
Parameters
const TListRequest &aRequest |
structure defining list request |
|
Return value
const TDesC8 & |
descriptor holding serialized list content or null descriptor if unable to get any data. |
|
Interface access: | internal to technology | Default as private. |
private: TVersion Version() const;
Description
Provides the version number of the server we require for this API.
Return value
TVersion |
TVersion object representing the version of the server |
|
Interface access: | internal to technology | Default as private. |
private: n/a
Description
Interface access: | internal to technology | Default as private. |
private: TBool iConnected;
Description
Interface access: | internal to technology | Default as private. |
private: TInt iMaxConfigParamSize;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare0;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare1;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare2;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare3;
Description