btobexprofiles/obexserviceman/obexservicemanclient/inc/ObexSMRequester.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) 2006-2007 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:  obexservicemanager client request class
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
#ifndef OBEXSMREQUESTER_H
hgs
parents:
diff changeset
    20
#define OBEXSMREQUESTER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <locodservicepluginobserver.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include <e32def.h>
hgs
parents:
diff changeset
    25
#include "ObexSMPlugin.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
class MObexSMRequestObserver;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
 *  Active object request class
hgs
parents:
diff changeset
    32
 *
hgs
parents:
diff changeset
    33
 *  Its instance will be used to control Asynchronous request
hgs
parents:
diff changeset
    34
 *  from ECom plugin to obex service manager server
hgs
parents:
diff changeset
    35
 *
hgs
parents:
diff changeset
    36
 *  @lib obexserviceman.lib
hgs
parents:
diff changeset
    37
 *  @since S60 3.2
hgs
parents:
diff changeset
    38
 */
hgs
parents:
diff changeset
    39
NONSHARABLE_CLASS(CObexSMRequester) : public CActive
hgs
parents:
diff changeset
    40
    {
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
public:
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
     * Two-phased constructor.
hgs
parents:
diff changeset
    46
     *
hgs
parents:
diff changeset
    47
     * @param aObserver the request completing observer
hgs
parents:
diff changeset
    48
     * @param aBearer the bearer identification
hgs
parents:
diff changeset
    49
     * @param aBearStatus the status of this bearer, ETrue
hgs
parents:
diff changeset
    50
                 if it is available EFalse otherwise.
hgs
parents:
diff changeset
    51
     */
hgs
parents:
diff changeset
    52
    static CObexSMRequester* NewL(MObexSMRequestObserver* aObserver,
hgs
parents:
diff changeset
    53
                                TLocodBearer aBearer, TBool aBearStatus); 
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
     * Two-phased constructor.
hgs
parents:
diff changeset
    57
     *
hgs
parents:
diff changeset
    58
     * @param aObserver the request completing observer
hgs
parents:
diff changeset
    59
     * @param aBearer the bearer identification
hgs
parents:
diff changeset
    60
     * @param aBearStatus the status of this bearer, ETrue
hgs
parents:
diff changeset
    61
                 if it is available EFalse otherwise.
hgs
parents:
diff changeset
    62
     */
hgs
parents:
diff changeset
    63
    static CObexSMRequester* NewLC(MObexSMRequestObserver* aObserver,
hgs
parents:
diff changeset
    64
                                TLocodBearer aBearer, TBool aBearStatus); 
hgs
parents:
diff changeset
    65
    /**
hgs
parents:
diff changeset
    66
     * Destructor.
hgs
parents:
diff changeset
    67
     */
hgs
parents:
diff changeset
    68
    virtual ~CObexSMRequester();
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    /**
hgs
parents:
diff changeset
    71
     * Request function   
hgs
parents:
diff changeset
    72
     *   
hgs
parents:
diff changeset
    73
     * @since S60 3.2     
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
    void ActivateRequest();
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * Get Request Status     
hgs
parents:
diff changeset
    78
     *
hgs
parents:
diff changeset
    79
     * @since S60 3.2    
hgs
parents:
diff changeset
    80
     * @return the requested status 
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    TBool GetStatus();
hgs
parents:
diff changeset
    83
    
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * Get the requested bearer
hgs
parents:
diff changeset
    86
     *
hgs
parents:
diff changeset
    87
     * @since S60 3.2    
hgs
parents:
diff changeset
    88
     * @return the requested bearer
hgs
parents:
diff changeset
    89
     */
hgs
parents:
diff changeset
    90
    TLocodBearer GetBearer();
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
protected:
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
    // from base class CActive
hgs
parents:
diff changeset
    95
    /**
hgs
parents:
diff changeset
    96
     * From CActive. 
hgs
parents:
diff changeset
    97
     * Cancel current activity.
hgs
parents:
diff changeset
    98
     *
hgs
parents:
diff changeset
    99
     * @since S60 3.2     
hgs
parents:
diff changeset
   100
     */
hgs
parents:
diff changeset
   101
    void DoCancel();
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    /**
hgs
parents:
diff changeset
   104
     * From CActive. 
hgs
parents:
diff changeset
   105
     * Called when read or write operation is ready.
hgs
parents:
diff changeset
   106
     *
hgs
parents:
diff changeset
   107
     * @since S60 3.2     
hgs
parents:
diff changeset
   108
     */
hgs
parents:
diff changeset
   109
    void RunL();
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
    /**
hgs
parents:
diff changeset
   112
     * From CActive. 
hgs
parents:
diff changeset
   113
     * Called if RunL() leaves. Retry listening after error.
hgs
parents:
diff changeset
   114
     *
hgs
parents:
diff changeset
   115
     * @since S60 3.x
hgs
parents:
diff changeset
   116
     * @param aError the error code
hgs
parents:
diff changeset
   117
     */
hgs
parents:
diff changeset
   118
    TInt RunError( TInt aError );
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
private:
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
    CObexSMRequester(MObexSMRequestObserver* aObserver, TLocodBearer aBearer, TBool aBearStatus);
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    void ConstructL();
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
private: // data    
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
    MObexSMRequestObserver* iObserver;
hgs
parents:
diff changeset
   130
    TLocodBearer            iBearer;
hgs
parents:
diff changeset
   131
    TBool                   iBearStatus; 
hgs
parents:
diff changeset
   132
    };
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
#endif //  OBEXSMREQUESTER_H