epoc32/include/mw/bioscmds.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) 1998-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 "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #if !defined(__E32BASE_H__)
    17 #include <e32base.h>
    18 #endif
    19 #if !defined (__BIOSCMDS_H__)
    20 #define __BIOSCMDS_H__
    21 
    22 #if !defined (__MSVSTD_HRH__)
    23 #include <msvstd.hrh>
    24 #endif
    25 
    26 /** BIO message MTM commands for CBIOClientMtm::InvokeAsyncFunctionL().
    27 
    28 The behaviour resulting from the command is specific to the BIO message type. 
    29 Typically, parsing causes an interpretation of the raw message body, and storage 
    30 of the results. Processing causes some system action to take place according 
    31 to the instructions in the message. */
    32 enum TBiosCmds {
    33 	/** Parse the BIO message. */
    34 	KBiosMtmParse = KMtmFirstFreeMtmFunctionId,
    35 	/** Parse then process the BIO message. */
    36 	KBiosMtmParseThenProcess,
    37 	/** Process the BIO message. */
    38 	KBiosMtmProcess
    39 };
    40 
    41 //
    42 // progress class (just report a state and an error code)
    43 // 
    44 class TBioProgress
    45 /** Progress information for BIO server MTM.
    46 
    47 Progress information can be requested using CMsvOperation::ProgressL(). 
    48 @publishedPartner
    49 @released
    50 */
    51 	{
    52 public:
    53 	/** BIO server MTM state. */
    54 	enum TBioState 
    55 		{
    56 		/** Waiting for a command. */
    57 		EBiosWaiting,
    58 		/** Creating a parser. */
    59 		EBiosCreating,
    60 		/** Parsing a message. */
    61 		EBiosParsing,
    62 		/** Processing a message. */
    63 		EBiosProcessing
    64 		};
    65 
    66 	/** BIO server MTM state. */
    67 	TBioState			iBioState;
    68 	/** Error code. */
    69 	TInt				iErrorCode; // client side needs to be informed of an error
    70 	/** Percentage of operation done. */
    71 	TInt				iPercentDone;
    72 	};
    73 
    74 #endif