btobexprofiles/obexsendservices/obexservicesendutils/inc/BTServiceAPI.h
author hgs
Fri, 28 May 2010 17:03:06 +0300
changeset 32 19bd632b5100
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  API for sending services
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef BT_SERVICE_API_H
hgs
parents:
diff changeset
    21
#define BT_SERVICE_API_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include "BTServiceParameterList.h"
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// CONSTANTS
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// DATA TYPES
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
enum TBTServiceType
hgs
parents:
diff changeset
    31
    {
hgs
parents:
diff changeset
    32
    EBTSendingService,
hgs
parents:
diff changeset
    33
    EBTPrintingService,
hgs
parents:
diff changeset
    34
    EBTObjectPushService // use this if support for only OPP is wanted
hgs
parents:
diff changeset
    35
    };
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    38
class CBTServiceStarter;
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
// CLASS DECLARATION
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*  An API for starting Bluetooth services.
hgs
parents:
diff changeset
    44
*
hgs
parents:
diff changeset
    45
*  @lib BtServiceUtils.lib
hgs
parents:
diff changeset
    46
*  @since Series 60 2.6
hgs
parents:
diff changeset
    47
*/
hgs
parents:
diff changeset
    48
class CBTServiceAPI : public CBase
hgs
parents:
diff changeset
    49
    {
hgs
parents:
diff changeset
    50
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    51
        
hgs
parents:
diff changeset
    52
        /**
hgs
parents:
diff changeset
    53
        * Two-phased constructor.
hgs
parents:
diff changeset
    54
        */
hgs
parents:
diff changeset
    55
        IMPORT_C static CBTServiceAPI* NewL();
hgs
parents:
diff changeset
    56
        
hgs
parents:
diff changeset
    57
        /**
hgs
parents:
diff changeset
    58
        * Destructor.
hgs
parents:
diff changeset
    59
        */
hgs
parents:
diff changeset
    60
        virtual ~CBTServiceAPI();
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    public: // New functions
hgs
parents:
diff changeset
    63
        
hgs
parents:
diff changeset
    64
        /**
hgs
parents:
diff changeset
    65
        * Starts the given service.
hgs
parents:
diff changeset
    66
        * Returns when service is started.
hgs
parents:
diff changeset
    67
        * @since Series 60 2.6
hgs
parents:
diff changeset
    68
        * @param aService The service to be started.
hgs
parents:
diff changeset
    69
        * @param aList Parameters for the service.
hgs
parents:
diff changeset
    70
        * @return None.
hgs
parents:
diff changeset
    71
        */
hgs
parents:
diff changeset
    72
        IMPORT_C void StartServiceL( TBTServiceType aService, 
hgs
parents:
diff changeset
    73
                                     CBTServiceParameterList* aList );
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
        /**
hgs
parents:
diff changeset
    76
        * Starts the given service.
hgs
parents:
diff changeset
    77
        * Returns when service is completed.
hgs
parents:
diff changeset
    78
        * @since Series 60 2.6
hgs
parents:
diff changeset
    79
        * @param aService The service to be started.
hgs
parents:
diff changeset
    80
        * @param aList Parameters for the service.
hgs
parents:
diff changeset
    81
        * @return None.
hgs
parents:
diff changeset
    82
        */
hgs
parents:
diff changeset
    83
        IMPORT_C void StartSynchronousServiceL( TBTServiceType aService, 
hgs
parents:
diff changeset
    84
                                     CBTServiceParameterList* aList );
hgs
parents:
diff changeset
    85
    private:
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
        * C++ default constructor.
hgs
parents:
diff changeset
    89
        */
hgs
parents:
diff changeset
    90
        CBTServiceAPI();
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
        * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
    94
        */
hgs
parents:
diff changeset
    95
        void ConstructL();
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
    private:    // Data
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
        CBTServiceStarter*      iStarter;
hgs
parents:
diff changeset
   100
        CActiveSchedulerWait    iSyncWaiter;
hgs
parents:
diff changeset
   101
    };
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
#endif      // BT_SERVICE_API_H
hgs
parents:
diff changeset
   104
            
hgs
parents:
diff changeset
   105
// End of File