bluetoothengine/bteng/inc/btengactive.h
branchRCL_3
changeset 23 9386f31cc85b
parent 22 613943a21004
equal deleted inserted replaced
22:613943a21004 23:9386f31cc85b
    38  *  @lib bteng*.lib
    38  *  @lib bteng*.lib
    39  *  @since S60 v3.2
    39  *  @since S60 v3.2
    40  */
    40  */
    41 class MBTEngActiveObserver
    41 class MBTEngActiveObserver
    42     {
    42     {
       
    43 
    43 public:
    44 public:
    44 
    45 
    45     /**
    46     /**
    46      * Callback to notify that an outstanding request has completed.
    47      * Callback to notify that an outstanding request has completed.
    47      *
    48      *
    48      * @since S60 v3.2
    49      * @since S60 v3.2
    49      * @param aActive Pointer to the active object that completed.
    50      * @param aActive Pointer to the active object that completed.
       
    51      * @param aId The ID that identifies the outstanding request.
    50      * @param aStatus The status of the completed request.
    52      * @param aStatus The status of the completed request.
    51      */
    53      */
    52     virtual void RequestCompletedL( CBTEngActive* aActive, TInt aStatus ) = 0;
    54     virtual void RequestCompletedL( CBTEngActive* aActive, TInt aId, 
    53 
    55                                     TInt aStatus ) = 0;
    54     /**
    56 
    55      * Callback for handling cancelation of an outstanding request.
    57     /**
    56      *
    58      * Callback to notify that an error has occurred in RunL.
    57      * @since Symbian^4
    59      *
       
    60      * @param aActive Pointer to the active object that completed.
    58      * @param aId The ID that identifies the outstanding request.
    61      * @param aId The ID that identifies the outstanding request.
    59      */
    62      * @param aStatus The status of the completed request.
    60     virtual void CancelRequest( TInt aRequestId ) = 0;
    63      */
    61 
    64     virtual void HandleError( CBTEngActive* aActive, TInt aId, 
    62     /**
    65                                     TInt aError ) = 0;
    63      * Callback to notify that an error has occurred in RunL.
    66 
    64      *
       
    65      * @param aActive Pointer to the active object that completed.
       
    66      * @param aError The error occurred in RunL.
       
    67      */
       
    68     virtual void HandleError( CBTEngActive* aActive, TInt aError ) = 0;
       
    69     };
    67     };
       
    68 
    70 
    69 
    71 /**
    70 /**
    72  *  Class CBTEngActive
    71  *  Class CBTEngActive
    73  *
    72  *
    74  *  ?more_complete_description
    73  *  ?more_complete_description
   121      * @since S60 v3.2
   120      * @since S60 v3.2
   122      */
   121      */
   123     inline void GoActive();
   122     inline void GoActive();
   124 
   123 
   125     /**
   124     /**
       
   125      * Cancel an outstanding request.
       
   126      *
       
   127      * @since S60 v3.2
       
   128      */
       
   129     inline void CancelRequest();
       
   130 
       
   131     /**
   126      * Get a reference to the active object request status.
   132      * Get a reference to the active object request status.
   127      *
   133      *
   128      * @since S60 v3.2
   134      * @since S60 v3.2
   129      * @return Reference to the active object request status.
   135      * @return Reference to the active object request status.
   130      */
   136      */
   131     TRequestStatus& RequestStatus();
   137     TRequestStatus& RequestStatus();
   132 
   138 
   133 private:
       
   134 // from base class CActive
   139 // from base class CActive
   135 
   140 
   136     /**
   141     /**
   137      * From CActive.
   142      * From CActive.
   138      * Called by the active scheduler when the request has been cancelled.
   143      * Called by the active scheduler when the request has been cancelled.