epoc32/include/tools/coredump/plugindata.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 ECOM-plugin related classes used accross the Core Dump client/server interface 
    15 //
    16 
    17 
    18 
    19 /**
    20  @file
    21  @publishedPartner 
    22  @released
    23 */
    24 
    25 #ifndef PLUGINDATA_H
    26 #define PLUGINDATA_H
    27 
    28 /**
    29 @publishedPartner 
    30 @released
    31 
    32 Class used between Core Dump Server and its clients to request 
    33 the server to carry out actions on plugins, such as load/unload.
    34 @see CCrashConfig::LoadPlugin()
    35 */
    36 class TPluginRequest
    37 {
    38 public:
    39 
    40 	/** 
    41 	Type of plugin to request
    42 	*/
    43 	enum TPluginType
    44 		{
    45 		/** A formatter plugin */
    46 		EFormatter,
    47 		/** A writer plugin */
    48 		EWriter
    49 		};
    50 
    51 
    52 	/** Whether to load or unload the plugin */
    53 	TBool						iLoad;
    54 
    55 	/** Type of plugin */
    56 	TPluginType					iPluginType;
    57 
    58 	/** @internalTechnology */
    59 	TUint						iIndex;
    60 
    61 	/** Plugin UID, used to check correct plugin */
    62 	TUid						iUid;
    63 
    64 	/** @internalTechnology */
    65 	TUint32 iSpare1;
    66 
    67 	/** @internalTechnology */
    68 	TUint32 iSpare2;
    69 };
    70 
    71 
    72 /** Maximum length allowed for a plugin's name */
    73 #define KPluginNameLength (50)
    74 
    75 /** Maximum length allowed for a plugin's description */
    76 #define KPluginDescriptionLength (250)
    77 
    78 /**
    79 @publishedPartner 
    80 @released
    81 
    82 Detailed information about a plugin.
    83 @see RPluginList
    84 @see TPluginInfoBlock
    85 */
    86 class TPluginInfo
    87 {
    88 public:
    89 
    90 	/** Plugin's own version.
    91 	From rss file::IMPLEMENTATION_INFO::version_no */
    92 	TUint					iVersion;
    93 
    94 	/** Plugin's unique UID. 
    95 	From rss file::IMPLEMENTATION_INFO::implementation_uid */
    96 	TUid					iUid;
    97 
    98 	/** Plugin's own name.
    99 	From rss file::IMPLEMENTATION_INFO::display_name */
   100 	TBufC<KPluginNameLength>			iName;
   101 
   102 	/** Plugin's own description obtained from 
   103 	CCoreDumpFormatter->GetDescription()
   104 	@see CCoreDumpFormatter */
   105 	TBufC<KPluginDescriptionLength>	iDescription;
   106 
   107 	/** Plugin type : from TPluginRequest::TPluginType */
   108 	TPluginRequest::TPluginType	iType;
   109 
   110 	/** Plugin loaded state. */
   111 	TBool					iLoaded;
   112 
   113 	/** Reserved for future use
   114 	@internalTechnology */
   115 	TUint32 iSpare1;
   116 
   117 	/** @internalTechnology */
   118 	TUint32 iSpare2;
   119 };
   120 
   121 
   122 /**
   123 @publishedPartner 
   124 @released
   125 
   126 List of TPluginInfo objects.
   127 @see TPluginInfo
   128 @see RArray
   129 */
   130 typedef RArray<TPluginInfo>	RPluginList;
   131 
   132 
   133 
   134 #endif