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