MCL/sf/os/bt: comparison atext/server/inc/atextmetadata.h

equal deleted inserted replaced

-:29b1cd4cb562
+:b4a7eebaaebf
 *
 * Description:  Metadata for ATEXT
 *
 */
 #ifndef C_CATEXTMETADATA_H
 #define C_CATEXTMETADATA_H
 #include <e32base.h>
 #include <atext.h>
 #include "atextpluginobserver.h"
 class CATExtPluginBase;
 class CATExtListen;
-/**  Support types supported by RSS file (M|P|S) */
+/** Panic categories */
+enum TATExtPanicCategories
+{
+EPanicCategoryFaultyMaster = 1,
+EPanicCategoryPluginType   = 2
+};
+/**  Support types supported by RSS file (M|P|O) */
 enum TATExtSupportType
 {
 ESupportTypeUndefined = KErrNotFound,
 ESupportTypeMaster    = 0,
-ESupportTypePrimary,
+ESupportTypePartial,
-ESupportTypeSecondary
+ESupportTypeObserver
 };
 /**  Operation types, either for command handling or for URC receiving */
 enum TATExtOperationType
 {
 NONSHARABLE_CLASS( TATExtSearchHelper )
 {
 public:
-TATExtSearchHelper() : iPrimaryIndex( KErrNotFound ),
+TATExtSearchHelper() : iPartialIndex( KErrNotFound ),
-iSecondaryIndex( KErrNotFound ) {}
+iObserverIndex( KErrNotFound ) {}
 /**
-* Index to the primary entry
+* Index to the partial entry
 */
-TInt iPrimaryIndex;
+TInt iPartialIndex;
 /**
-* Index to the secondary entry
+* Index to the observer entry
 */
-TInt iSecondaryIndex;
+TInt iObserverIndex;
 };
 /**
 *  Class to store data needed for one AT command support.
 *  This includes the support's type and the plugin entry.
-*  Thus one plugin's RSS file may contain multiple M|P|S entries.
+*  Thus one plugin's RSS file may contain multiple M|P|O entries.
 *
 *  @since S60 v5.0
 */
 NONSHARABLE_CLASS( TATExtOneCmdSupport )
 {
 public:
 /**
-* Support's type (M|P|S)
+* Support's type (M|P|O)
 */
 TATExtSupportType iSupportType;
 /**
 * Plugin entry for support
 TATExtEntrySupport( TDesC8& aAtCmdFull,
 const RMessage2& aMessage,
 CArrayFixFlat<TATExtOneCmdSupport>* aSupport ) :
 iAtCmdFull( aAtCmdFull ),
 iMessage( aMessage ),
-iSupport( aSupport ) {}
+iSupport( aSupport ),
+iEntry( NULL ),
+iStartIndex( KErrNotFound ),
+iSupportFound( EFalse ){}
 /**
 * Full AT command for which to check the support
 * (base part + parameters)
 */
 */
 const RMessage2& iMessage;
 /**
 * AT command's plugin entry support data.
-* Used by SendToMultipleSecondaryL() and FindFirstSecondarySupportL().
+* Used by SendToMultipleObserverL() and FindFirstObserverSupportL().
 */
 CArrayFixFlat<TATExtOneCmdSupport>* iSupport;
 /**
 * Found plugin entry.
 */
 TATExtPluginEntry* iEntry;
 /**
-* Starts index for searches with HandlePrimaryPluginSupportL() and
+* Start index for searches with HandlePartialAndMasterPluginSupportL() and
-* HandleSecondaryPluginSupportL()
+* HandleObserverPluginSupportL()
 */
 TInt iStartIndex;
+/**
+* Found plugin support for HandlePartialAndMasterPluginSupportL().
+*/
+TBool iSupportFound;
 };
 /**
 *  Class for handling various operations of the server session which are
 *
 * @since S60 5.0
 * @param aCommands Command buffer from where to extract the next subcommand
 * @param aStartIndex Start index for the found command
 * @param aEndIndex End index for the found command
-* @param aSupportType Support's type (M|P|S)
+* @param aSupportType Support's type (M|P|O)
 * @return Symbian error code on error, KErrNone otherwise
 */
 TInt ExtractNextCommand( const TDesC8& aCommands,
 TInt& aStartIndex,
 TInt& aEndIndex,
 *
 * @since S60 5.0
 * @param aAtCmdBase Base AT command which to add to support data
 *                   (base part without parameters)
 * @param aPluginUid Plugin's UID to find from plugin data
-* @param aSupportType Support's type (M|P|S)
+* @param aSupportType Support's type (M|P|O)
 * @param aCleanupInfo Cleanup information
 * @return None
 */
 void AddEntryToMetadataL( TDes8& aAtCmdBase,
 TUid& aPluginUid,
 * Adds new plugin entry link from plugin support entry to plugin entry
 *
 * @since S60 5.0
 * @param aEntries Plugin entries for support
 * @param aEntryIndex Plugin index entry
-* @param aSupportType Support's type (M|P|S)
+* @param aSupportType Support's type (M|P|O)
 * @param aSearchHelper The search helper
 * @return Index to the added entry, KErrNotSupported otherwise
 */
 TInt AddNewMetadataEntryLinkL(
 CArrayFixFlat<TATExtOneCmdSupport>*& aEntries,
 CArrayFixFlat<TATExtOneCmdSupport>* aEntries,
 TATExtSearchHelper& aSearchHelper,
 TATExtOneCmdSupport& aOneCmdSupport );
 /**
-* Adds new primary plugin entry link from plugin support entry to plugin
+* Adds new partial plugin entry link from plugin support entry to plugin
 * entry
 *
 * @since S60 5.0
 * @return Index to the added entry, KErrNotSupported otherwise
 */
-TInt AddNewPrimaryMetadataEntryLinkL(
+TInt AddNewPartialMetadataEntryLinkL(
 CArrayFixFlat<TATExtOneCmdSupport>* aEntries,
 TATExtSearchHelper& aSearchHelper,
 TATExtOneCmdSupport& aOneCmdSupport );
 /**
-* Adds new secondary plugin entry link from plugin support entry to plugin
+* Adds new observer plugin entry link from plugin support entry to plugin
-* entry. Search starts from the front as there could be multiple S plugins
+* entry. Search starts from the front as there could be multiple O plugins
 * but only one or two M/P plugins.
 *
 * @since S60 5.0
 * @return Index to the added entry, KErrNotSupported otherwise
 */
-TInt AddNewSecondaryMetadataEntryLinkL(
+TInt AddNewObserverMetadataEntryLinkL(
 CArrayFixFlat<TATExtOneCmdSupport>* aEntries,
 TATExtSearchHelper& aSearchHelper,
 TATExtOneCmdSupport& aOneCmdSupport );
 /**
 * @return None
 */
 void CreateSelfReplyData( const RMessage2& aMessage );
 /**
-* Handles support when a master plugin is detected in the plugin data
+* Handles support when a master or partial plugin is detected in the plugin
-* via support data's link (support for a full AT command). If a master
+* data via support data's link. If a partial or master plugin is detected
-* plugin is detected then reply is detected from that plugin. No further
+* then reply is expected from that plugin. Also if one or more observer
-* sending to primary or secondary plugins is repformed.
+* plugins are detected then no reply is expected from them.
 *
 * @since S60 5.0
-* @param aEntrySupport Support data to the first found master plugin
+* @param aEntrySupport Support data to the first found partial or master plugin
-* @param aReplyExpected ETrue if reply is expected from the master plugin,
+* @param aStartIndex Start index to search the next observer plugin
-*                       EFalse if no reply is expected from the master plugin,
+* @param aReplyExpected ETrue if reply is expected from the partial or master plugin,
+*                       EFalse if no reply is expected from the partial or master plugin,
 *                       (i.e. no support found)
 * @return ETrue if support found, EFalse otherwise
 */
-TBool HandleMasterPluginSupportL( TATExtEntrySupport& aEntrySupport,
+TBool HandleMasterAndPartialPluginSupportL(
-TBool& aReplyExpected );
+TATExtEntrySupport& aEntrySupport,
+TInt aStartIndex,
-/**
+TBool& aReplyExpected );
-* Handles support when a primary plugin is detect in the plugin data
-* via support data's link. If a primary plugin is detected then reply is
+/**
-* expected from that plugin. Also if one or more secondary plugins are
+* Handles support when a observer plugin is detected in the plugin data
-* detected then no reply is expected from them.
+* via support data's link. If only one observer plugin is detected then
-*
+* reply is expected from that plugin. Instead, if more than one observer
-* @since S60 5.0
-* @param aEntrySupport Support data to the first found primary plugin
-* @param aStartIndex Start index to search the next secondary plugin
-* @param aReplyExpected ETrue if reply is expected from the primary plugin,
-*                       EFalse if no reply is expected from the primary plugin,
-*                       (i.e. no support found)
-* @return ETrue if support found, EFalse otherwise
-*/
-TBool HandlePrimaryPluginSupportL( TATExtEntrySupport& aEntrySupport,
-TInt aStartIndex,
-TBool& aReplyExpected );
-/**
-* Handles support when a secondary plugin is detected in the plugin data
-* via support data's link. If only one secondary plugin is detected then
-* reply is expected from that plugin. Instead, if more than one secondary
 * plugins are detected then no reply is expected from them.
 *
 * @since S60 5.0
-* @param aEntrySupport Support data to the first found secondary plugin
+* @param aEntrySupport Support data to the first found observer plugin
 *                      entry
-* @param aStartIndex Start index to search the next secondary plugin
+* @param aStartIndex Start index to search the next observer plugin
 * @param aReplyExpected ETrue if reply is expected from one or more plugins,
 *                       EFalse if no reply is expected from any of the plugins
 * @return ETrue if support found, EFalse otherwise
 */
-TBool HandleSecondaryPluginSupportL( TATExtEntrySupport& aEntrySupport,
+TBool HandleObserverPluginSupportL( TATExtEntrySupport& aEntrySupport,
 TInt aStartIndex,
 TBool& aReplyExpected );
+/**
+* Finds exclusive partial plugin support
+*
+* @since S60 5.0
+* @param aEntrySupport Support data to the first found partial plugin entry
+* @return ETrue if exclusive support found, EFalse otherwise
+*/
+TBool FindExclusivePartialSupportL( TATExtEntrySupport& aEntrySupport );
 /**
 * Finds support entries from support data for a given base AT command
 *
 * @since S60 5.0
 void HandleCommandL( TATExtEntrySupport& aEntrySupport,
 TBool aReplyNeeded,
 const TDesC8* aAtCmdFull=NULL );
 /**
-* Sends an AT commands to multiple secondary plugins, starting from a
+* Sends an AT commands to multiple observer plugins, starting from a
 * given position.
 *
 * @since S60 5.0
 * @param aEntrySupport Entry support data to position from where to start
-*                      sending to the found secondary plugins
+*                      sending to the found observer plugins
 * @param aAtCmdFull Full AT command to send (base part + parameters)
 * @return None
 */
-void SendToMultipleSecondaryL( TATExtEntrySupport& aEntrySupport,
+void SendToMultipleObserverL( TATExtEntrySupport& aEntrySupport,
 const TDesC8* aAtCmdFull );
 /**
-* Finds the first secondary plugin support from a given starting position
+* Finds the first observer plugin support from a given starting position
 *
 * @since S60 5.0
 * @param aEntrySupport Entry support data to the next entry after the found
-*                      secondary plugin entry; marks the start for search
+*                      observer plugin entry; marks the start for search
 * @return ETrue if support found, EFalse otherwise
 */
-TBool FindFirstSecondarySupportL( TATExtEntrySupport& aEntrySupport );
+TBool FindFirstObserverSupportL( TATExtEntrySupport& aEntrySupport );
 /**
 * Extracts one NVRAM entry from a pipe-character delimited NVRAM buffer
 *
 * @since S60 5.0

changeset 1	b4a7eebaaebf
parent 0	29b1cd4cb562
child 12	9b6d3ca0c601