Collapse all Symbian^3 Application Developer Library

CGbaUtility Class Reference

class CGbaUtility : public CBase

Interface for handling gba bootstrapping

gba2.lib

Since: S60 3.2

Inherits from

CGbaUtility
- CBase

Public Member Functions
	~CGbaUtility ()
IMPORT_C TInt	Bootstrap (const TGBABootstrapInputParams , TGBABootstrapOutputParams &)
IMPORT_C void	Bootstrap (const TGBABootstrapInputParams , TGBABootstrapOutputParams &, TRequestStatus &)
IMPORT_C TInt	CancelBootstrap ()
IMPORT_C CGbaUtility *	NewL ( MGbaObserver &)
IMPORT_C CGbaUtility *	NewL ()
IMPORT_C CGbaUtility *	NewLC ( MGbaObserver &)
IMPORT_C CGbaUtility *	NewLC ()
IMPORT_C TInt	SetBSFAddress (const TDesC8 &)

Private Member Functions
	CGbaUtility ()
void	ConstructL ( MGbaObserver &)
void	ConstructL ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CGbaClientRequestHandler *	iGbaRequestHandler

Constructor & Destructor Documentation

CGbaUtility()

CGbaUtility

(

)

[private]

~CGbaUtility()

~CGbaUtility

(

)

[virtual]

destructor

Member Functions Documentation

Bootstrap(const TGBABootstrapInputParams, TGBABootstrapOutputParams &)

IMPORT_C TInt	Bootstrap	(	const TGBABootstrapInputParams	aInput,
			TGBABootstrapOutputParams &	aOutput
		)

Bootstrap function. It is a asynchronous function with callback function. Performs a bootstrap and calls the callback function when bootstrap is done. This function should be used when the instance of CGbaUtility is created by factory function with observer. This function requires ReadDeviceData capability

Since: S60 3.2

Parameters

const TGBABootstrapInputParams aInput	- structure to hold input parameters, aOutput - structure to hold output parameters client must ensure that ouput buffer is available when boostrapping is completed
TGBABootstrapOutputParams & aOutput

Bootstrap(const TGBABootstrapInputParams, TGBABootstrapOutputParams &, TRequestStatus &)

IMPORT_C void	Bootstrap	(	const TGBABootstrapInputParams	aInput,
			TGBABootstrapOutputParams &	aOutput,
			TRequestStatus &	aStatus
		)

Performs asynchronous bootstrap. This function should be used when the instance of CGbaUtility is created by factory function without observer. This function requires ReadDeviceData capability

Since: S60 3.2

Parameters

const TGBABootstrapInputParams aInput	- structure to hold input parameters, aOutput - structure to hold output parameters client must ensure that ouput buffer is available when boostrapping is completed aStatus - KErrNone - in case the bootstrap request is completed successfullyKErrCancel - in case the bootstrap request is cancelledKErrInUse - if there any outstanding bootstrap request in place
TGBABootstrapOutputParams & aOutput
TRequestStatus & aStatus

CancelBootstrap()

IMPORT_C TInt

CancelBootstrap

(

)

Cancel Bootstrap function

Since: S60 3.2

ConstructL(MGbaObserver &)

void

ConstructL

(

MGbaObserver &

aObserver

)

[private]

Parameters

MGbaObserver & aObserver

ConstructL()

void

ConstructL

(

)

[private]

NewL(MGbaObserver &)

IMPORT_C CGbaUtility *

NewL

(

MGbaObserver &

aObserver

)

[static]

NewL factory function with an observer. It is used with callback function which should be implemented by the client. The interface is defined in class MGbaObserver

Since: S60 3.2

Parameters

MGbaObserver & aObserver

Client implemented observer that will be called when the bootstrap is done

NewL()

IMPORT_C CGbaUtility *

NewL

(

)

[static]

NewL factory function without observer. User should create its own state machine.

Since: S60 3.2

NewLC(MGbaObserver &)

IMPORT_C CGbaUtility *

NewLC

(

MGbaObserver &

aObserver

)

[static]

NewLC factory function with an observer. It is used with callback function which should be implemented by the client. The interface is defined in class MGbaObserver

Since: S60 3.2

Parameters

MGbaObserver & aObserver

Client implemented observer that will be called when the bootstrap is done

NewLC()

IMPORT_C CGbaUtility *

NewLC

(

)

[static]

NewLC factory function without observer. User should create its own state machine.

Since: S60 3.2

SetBSFAddress(const TDesC8 &)

IMPORT_C TInt

SetBSFAddress

(

const TDesC8 &

aAddress

)

Set the BSF address. required WriteDeviceData capability. The BSF address set by this function will overwrite the one calculated from IMPI.

Since: S60 3.2

Parameters

const TDesC8 & aAddress

Member Data Documentation

CGbaClientRequestHandler * iGbaRequestHandler

CGbaClientRequestHandler *

iGbaRequestHandler

[private]