bt_plat/at_command_handler_plugin_api/inc/atextpluginbase.h
changeset 21 5e5528a288fe
parent 0 29b1cd4cb562
equal deleted inserted replaced
19:4b81101308c6 21:5e5528a288fe
    31 
    31 
    32 /**  Reply types for the handled AT command */
    32 /**  Reply types for the handled AT command */
    33 enum TATExtensionReplyType
    33 enum TATExtensionReplyType
    34     {
    34     {
    35     EReplyTypeUndefined,  // For error conditions (handling failed)
    35     EReplyTypeUndefined,  // For error conditions (handling failed)
    36     EReplyTypeOther,      // For other than OK or ERROR
    36     EReplyTypeOther,      // !(EReplyTypeOk||EReplyTypeError||EReplyTypeEditor)
    37     EReplyTypeOk,         // For "OK"
    37     EReplyTypeOk,         // For "OK" (or "" in quiet mode)
    38     EReplyTypeError,      // For "ERROR"
    38     EReplyTypeError,      // For "ERROR" (or "" in quiet mode)
       
    39     EReplyTypeEditor,     // For editor mode
    39     };
    40     };
    40 
    41 
    41 /**  Default buffer length for command reply buffer */
    42 /**  Default buffer length for command reply buffer */
    42 const TUint KDefaultCmdBufLength = 1024;
    43 const TUint KDefaultCmdBufLength = 1024;
    43 
    44 
   141      * in BT HFP case, the format should be <cr><lf><result code><cr><lf>
   142      * in BT HFP case, the format should be <cr><lf><result code><cr><lf>
   142      *
   143      *
   143      * After an extension plugin has handled or decided to reject the given AT
   144      * After an extension plugin has handled or decided to reject the given AT
   144      * command, it must inform ATEXT by HandleCommandCompleted() with a proper
   145      * command, it must inform ATEXT by HandleCommandCompleted() with a proper
   145      * error code.
   146      * error code.
       
   147 	 *
       
   148 	 * Note that in editor mode the setting of aReplyNeeded is always "ETrue"
       
   149 	 * when a plugin processing the editor mode meets the end condition for the
       
   150 	 * editor mode (!EReplyTypeEditor reply in editor mode). In this case the
       
   151 	 * plugin must create the last reply even when aReplyNeeded is EFalse.
   146      *
   152      *
   147      * @since S60 5.0
   153      * @since S60 5.0
   148      * @param aCmd The AT command to be handled. Its format may vary depending
   154      * @param aCmd The AT command to be handled. Its format may vary depending
   149      *             on the specification. E.g. in BT HFP case, the command may
   155      *             on the specification. E.g. in BT HFP case, the command may
   150      *             contain a character carriage return (<cr>) in the end.
   156      *             contain a character carriage return (<cr>) in the end.