Collapse all Symbian^3 Product Developer Library

BasebandChannelAdaptation2::MBca2 Class Reference

class BasebandChannelAdaptation2::MBca2

The interface implemented by the lower component to accept control signals from the upper component

Nested Classes and Structures

BasebandChannelAdaptation2::MBca2::TBcaParams

Public Member Functions
void	CancelControl()
void	Close()
void	Control(TRequestStatus &, TUint, TUint, TDes8 &)
MLowerDataSender &	GetSender()
TInt	Open(MUpperControl &, MUpperDataReceiver &, const TBcaParams &)
void	Release()
void	SetFlowControl(TBlockOption)
void	Start()

Public Member Enumerations
enum	TBlockOption { EBlockFlow, EUnblockFlow }

Member Functions Documentation

CancelControl()

void

CancelControl

(

)

[pure virtual]

Cancels the Control request in a synchronous way.

Close()

void

(

)

[pure virtual]

Synchronously closes the BCA immediately. Informs the BCA is no longer required by the client and can release its resources. Close cancels all pending asynchronous operations which can only be Start() or Control() . To use the BCA instance it needs to be re-opened. Close operation must not fail.

Control(TRequestStatus &, TUint, TUint, TDes8 &)

void	Control	(	TRequestStatus &	aStatus,
			TUint	aOptLevel,
			TUint	aOptName,
			TDes8 &	aOpt
		)	[pure virtual]

The BCA control function to get or set the options of the BCA in an asynchronous manner.

Parameters

TRequestStatus & aStatus	asynchronous completion status, KErrNone if successful, system-wide error code otherwise
TUint aOptLevel	option level to be used KBcaOptLevelGeneric or KBcaOptLevelExtSerial
TUint aOptName	option name to be used.
TDes8 & aOpt	an optional parameter,holds the option value on return or the option value to be set.

GetSender()

MLowerDataSender &

GetSender

(

)

[pure virtual]

Returns a reference to the MLowerDataSender, This reference is used by upper components to send packets to the lower components. This API must be called only after Start() completes, otherwise the implementation should panic.

Open(MUpperControl &, MUpperDataReceiver &, const TBcaParams &)

TInt	Open	(	MUpperControl &	aControl,
			MUpperDataReceiver &	aData,
			const TBcaParams &	aBcaParams
		)	[pure virtual]

Opens the BCA instance and commences a BCA session (Close() terminates the session).

Parameters

MUpperControl & aControl	reference to a MUpperControl implementation, which will serve as the call-back interface for incoming control calls
MUpperDataReceiver & aData	- reference to a MUpperDataReceiver implementation, which will serve as the call-back interface for incoming data
const TBcaParams & aBcaParams	A reference to the BCA start up params

Release()

void

Release

(

)

[pure virtual]

Release/deletes the BCA instance. Derived classes will typically implement this as delete this .

SetFlowControl(TBlockOption)

void

SetFlowControl

(

TBlockOption

aOption

)

[pure virtual]

Either blocks or unblocks the pushing of received data to the upper layers, depending on TBlockOption. If the upper layers can t process any more data to stop receiving packets this API is called with EBlockFlow. Later after the congestion eases, to start receiving packets again call this API with EUnblockFlow

Parameters

TBlockOption aOption

either block or unblock receive flow

Start()

void

Start

(

)

[pure virtual]

The API starts the baseband connection asynchronously. The Start () request API s successful completion is acknowledged with MUpperControl::StartSending(). The request failure is acknowledged with MUpperControl::Error(). Client should take care of scenarios when MUpperControl::StartSending() gets very delayed or not called at all

Member Enumerations Documentation

Enum TBlockOption

Enumerators

EBlockFlow
EUnblockFlow