devicesrv_plat/dos_extension_plugin_api/inc/dosdsy.h
changeset 0 4e1aa6a622a0
child 34 b2f9f823b5fb
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef __DOSDSY_H__
       
    20 #define __DOSDSY_H__
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <bttypes.h> // THCIConnHandle, TBDAddress
       
    24 #include "dossvrservices.h" // TBTDeviceType
       
    25 
       
    26 class CDosExtensionBase;
       
    27 
       
    28 /**
       
    29 * Abstract class that defines the mandatory functions to be written in 
       
    30 * the plug-in when creating the licensee specific Factory class.
       
    31 * The Factory class is responsible for creating and delivering services 
       
    32 * to the Dos Server on its demand.
       
    33 */
       
    34 class MDosFactoryBaseDSY
       
    35 {
       
    36 public:
       
    37 	/**
       
    38 	* The implementation should create a licensee specific Extension Service.
       
    39 	* @return A pointer to the newly created object.
       
    40 	*/
       
    41 	virtual CDosExtensionBase* NewExtensionServiceL()=0;
       
    42 
       
    43 	
       
    44 };
       
    45 
       
    46 /**
       
    47 * Abstract class that defines the mandatory functions to be written in 
       
    48 * the plug-in when creating the licensee specific Extension service class.
       
    49 * The Extension service is responsible for completing the RDosExtension 
       
    50 * requests.
       
    51 */
       
    52 class MDosExtensionBaseDSY
       
    53 {
       
    54 public:
       
    55 
       
    56 	/**
       
    57 	* Implements a raw function call. The implementation is supposed to interpret the parameters and
       
    58 	* satisfy the requests.
       
    59 	* @param aFunc Unique integer among the extended functions what function we are calling.
       
    60 	* @param aParameter A pointer to the parameter.
       
    61 	* @param aParLength Length of the parameter.
       
    62 	* @param aParameterModified ETrue if the content of aParameter has changed, EFalse otherwise
       
    63 	* @return Symbian error code.
       
    64 	*/
       
    65 	virtual TInt CallFunctionL(TInt aFunc , TAny *aParameter , TInt aParLength, TBool& aParameterModified)=0;
       
    66 
       
    67 	/**
       
    68 	* Implements a raw function call. The implementation is supposed to interpret the parameters and
       
    69 	* satisfy the requests. The implemtation should also complete the message.
       
    70 	* @param aFunc Unique integer among the extended functions what function we are calling.
       
    71 	* @param aParameter A pointer to the parameter.
       
    72 	* @param aParLength Length of the parameter.
       
    73 	* @param aMessage The message to be completed.
       
    74 	* @return Symbian error code.
       
    75 	*/
       
    76 	virtual void CallFunctionAndCompleteL(TInt aFunc , TAny *aParameter , TInt aParLength, const RMessage2& aMessage)=0;
       
    77 };
       
    78 
       
    79 #endif //__DOSDSY_H__