sbDeviceStatusAutoOperationComplete Class Reference

#include <sbDeviceStatusHelper.h>

Inheritance diagram for sbDeviceStatusAutoOperationComplete:
[legend]

Public Types

typedef
sbBaseDevice::TransferRequest 
TransferRequest
 

Public Member Functions

 sbDeviceStatusAutoOperationComplete ()
 
 sbDeviceStatusAutoOperationComplete (sbDeviceStatusHelper *aStatus, sbDeviceStatusHelper::Operation aOperation, TransferRequest *aRequest, PRUint32 aBatchCount)
 
 sbDeviceStatusAutoOperationComplete (sbDeviceStatusHelper *aStatus, sbDeviceStatusHelper::Operation aOperation)
 
 sbDeviceStatusAutoOperationComplete (sbDeviceStatusHelper *aStatus, sbDeviceStatusHelper::Operation aOperation, TransferRequest *aRequest, PRInt32 aBatchCount)
 
 ~sbDeviceStatusAutoOperationComplete ()
 
void Complete ()
 
void SetResult (nsresult aResult)
 
void Transfer (sbDeviceStatusAutoOperationComplete &aDestination)
 

Static Public Member Functions

static bool IsItemOp (sbDeviceStatusHelper::Operation aOperation)
 

Detailed Description

Auto completes an operation. Once constructed the auto class is set to auto fail. In order to auto complete a success you must call SetResult with NS_OK.

Definition at line 194 of file sbDeviceStatusHelper.h.

Member Typedef Documentation

Constructor & Destructor Documentation

sbDeviceStatusAutoOperationComplete::sbDeviceStatusAutoOperationComplete ( )
inline

Default constructor used when expecting to transfer auto complete

Definition at line 217 of file sbDeviceStatusHelper.h.

sbDeviceStatusAutoOperationComplete::sbDeviceStatusAutoOperationComplete ( sbDeviceStatusHelper aStatus,
sbDeviceStatusHelper::Operation  aOperation,
TransferRequest aRequest,
PRUint32  aBatchCount 
)

Initialize the request and status, start the operation and setup to auto fail. Must Call SetResult for successful completion

Definition at line 101 of file sbDeviceStatusHelper.cpp.

Here is the call graph for this function:

sbDeviceStatusAutoOperationComplete::sbDeviceStatusAutoOperationComplete ( sbDeviceStatusHelper aStatus,
sbDeviceStatusHelper::Operation  aOperation 
)

Definition at line 148 of file sbDeviceStatusHelper.cpp.

sbDeviceStatusAutoOperationComplete::sbDeviceStatusAutoOperationComplete ( sbDeviceStatusHelper aStatus,
sbDeviceStatusHelper::Operation  aOperation,
TransferRequest aRequest,
PRInt32  aBatchCount 
)

Initialize the request and status, start the operation and setup to auto fail. Must Call SetResult for successful completion This version allows overriding of the batch count

Definition at line 165 of file sbDeviceStatusHelper.cpp.

Here is the call graph for this function:

sbDeviceStatusAutoOperationComplete::~sbDeviceStatusAutoOperationComplete ( )

If this is the last item in the batch then call the OperationComplete method.

Definition at line 184 of file sbDeviceStatusHelper.cpp.

Here is the call graph for this function:

Member Function Documentation

void sbDeviceStatusAutoOperationComplete::Complete ( )

Complete the operation

Definition at line 188 of file sbDeviceStatusHelper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

static bool sbDeviceStatusAutoOperationComplete::IsItemOp ( sbDeviceStatusHelper::Operation  aOperation)
inlinestatic

Definition at line 198 of file sbDeviceStatusHelper.h.

Here is the caller graph for this function:

void sbDeviceStatusAutoOperationComplete::SetResult ( nsresult  aResult)
inline

Set the result code for auto complete. Success code will set the operation as completed successfully

Definition at line 258 of file sbDeviceStatusHelper.h.

Here is the caller graph for this function:

void sbDeviceStatusAutoOperationComplete::Transfer ( sbDeviceStatusAutoOperationComplete aDestination)

Transfers the auto complete function to another object

Definition at line 204 of file sbDeviceStatusHelper.cpp.


The documentation for this class was generated from the following files: