Collapse all Symbian^3 Product Developer Library

RAccessoryAsyComms Class Reference

class RAccessoryAsyComms : public RAccessorySubsessionBase

AsyComms sub-session represents AsyComms connection Provides methods for NotifyProcessCommands and ProcessResponses

ASYComms.dll

Since: S60 3.1

Inherits from

RAccessoryAsyComms
- RAccessorySubsessionBase
  - RSubSessionBase

Public Member Functions
	RAccessoryAsyComms()
IMPORT_C void	CancelNotifyProcessCommand()
IMPORT_C TInt	CloseSubSession()
IMPORT_C TInt	CreateSubSession(RAccessoryServer &, const TUid)
IMPORT_C void	GetBuffer(TPtr8)
IMPORT_C void	NotifyProcessCommand(TRequestStatus &, TProcessCmdId &, TInt &, TASYCmdParams &)
IMPORT_C void	NotifyProcessCommand(TRequestStatus &, TProxyCommandPckgBuf &, TPtr8 &)
IMPORT_C void	ProcessResponse(const TInt, const TAccValueTypeTBool, const TInt)
IMPORT_C void	ProcessResponse(const TInt, const TAccValueTypeTInt, const TInt)
IMPORT_C void	ProcessResponse(const TInt, const TDesC8 &, const TInt)
IMPORT_C void	ProcessResponse(const TInt, TPtr8 *, const TInt)

Private Member Functions
IMPORT_C TInt	CreateSubSession(RAccessoryServer &)
void	ExternalizeL(CBufFlat *&, CAccPolObjectBase &)

Inherited Functions
	RAccessorySubsessionBase::RAccessorySubsessionBase()
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Private Attributes
TAccSrvProcessCmdIdPckg	iProcessCmdIdPckg
TPckg< TInt >	iTransactionIDPckg

Constructor & Destructor Documentation

RAccessoryAsyComms()

IMPORT_C

RAccessoryAsyComms

(

)

C++ default constructor.

Member Functions Documentation

CancelNotifyProcessCommand()

IMPORT_C void

CancelNotifyProcessCommand

(

)

Cancel NotifyProcessCommand().

Since: S60 3.1

CloseSubSession()

IMPORT_C TInt

CloseSubSession

(

)

[virtual]

Closes the RAccessoryAsyComms sub-session. This function must be called for all RAccessoryAsyComms sub-sessions which have been created

Since: S60 3.1

CreateSubSession()

CreateSubSession(RAccessoryServer &, const TUid)

IMPORT_C TInt	CreateSubSession	(	RAccessoryServer &	aSession,
			const TUid	aMainServiceUid
		)

Creates a new sub-session within an existing session.

Since: S60 3.1

Parameters

RAccessoryServer & aSession	The session to which this sub-session will belong.
const TUid aMainServiceUid	Implementation uid of main service ASY

CreateSubSession(RAccessoryServer &)

IMPORT_C TInt

CreateSubSession

(

RAccessoryServer &

aSession

)

[private, virtual]

Definition for pure virtual function defined in base class. Declaration is empty.

Parameters

RAccessoryServer & aSession

ExternalizeL(CBufFlat *&, CAccPolObjectBase &)

void	ExternalizeL	(	CBufFlat *&	aBuf,
			CAccPolObjectBase &	aValue
		)	[private]

Externalize aValue to aBuf.

Parameters

CBufFlat *& aBuf
CAccPolObjectBase & aValue

GetBuffer(TPtr8)

IMPORT_C void

GetBuffer

(

TPtr8

aPtr

)

Read the CAccPolObjectBase buffer.

Parameters

TPtr8 aPtr

Pointer to buffer where CAccPolObjectBase type of object is written to in externalized format.

NotifyProcessCommand(TRequestStatus &, TProcessCmdId &, TInt &, TASYCmdParams &)

IMPORT_C void	NotifyProcessCommand	(	TRequestStatus &	aStatus,
			TProcessCmdId &	aCmdn,
			TInt &	aTrId,
			TASYCmdParams &	aASYCommandParamRecord
		)

Process command request. Actual request takes place when this asynchronous request completes

Since: S60 3.1

The AsyCmdTypes.h, where TASYCmdParams is declared.

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TProcessCmdId & aCmdn	On successful request completion, contains the updated ProcessCommand ID
TInt & aTrId	On successful request completion, contains the updated Transaction ID
TASYCmdParams & aASYCommandParamRecord	On successful request completion contains the updated parameters.

NotifyProcessCommand(TRequestStatus &, TProxyCommandPckgBuf &, TPtr8 &)

IMPORT_C void	NotifyProcessCommand	(	TRequestStatus &	aStatus,
			TProxyCommandPckgBuf &	aParams,
			TPtr8 &	aPtr
		)

Process command request. Actual request takes place when this asynchronous request completes

Since: S60 3.1

The AsyCmdTypes.h, where TASYCmdParams is declared.

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TProxyCommandPckgBuf & aParams
TPtr8 & aPtr	Pointer to buffer where CAccPolObjectBase type of object is written to in externalized format. ProcessCommand ID, Transaction ID and ASYCommandParamRecord parameters.

ProcessResponse(const TInt, const TAccValueTypeTBool, const TInt)

IMPORT_C void	ProcessResponse	(	const TInt	aTrid,
			const TAccValueTypeTBool	aCmdResponse,
			const TInt	aErrCode
		)

Handles responses get from ASYproxy for previously made NotifyProcessCommands() -call. ASYProxy calls this function if TProcessCmdId was ECmdProcessCommandInit or ECmdGetValueBool

Since: S60 3.1

Parameters

const TInt aTrid	Transaction id
const TAccValueTypeTBool aCmdResponse	Response data
const TInt aErrCode	KErrNone if succesful, system-wide error code if failed.

ProcessResponse(const TInt, const TAccValueTypeTInt, const TInt)

IMPORT_C void	ProcessResponse	(	const TInt	aTrid,
			const TAccValueTypeTInt	aCmdResponse,
			const TInt	aErrCode
		)

Handles responses get from ASYproxy for previously made NotifyProcessCommands() -call. ASYProxy calls this function if TProcessCmdId was ECmdGetValueTInt

Since: S60 3.1

Parameters

const TInt aTrid	Transaction id
const TAccValueTypeTInt aCmdResponse	Response data
const TInt aErrCode	KErrNone if succesful, system-wide error code if failed.

ProcessResponse(const TInt, const TDesC8 &, const TInt)

IMPORT_C void	ProcessResponse	(	const TInt	aTrid,
			const TDesC8 &	aCmdResponse,
			const TInt	aErrCode
		)

Handles responses get from ASYproxy for previously made NotifyProcessCommands() -call. ASYProxy calls this function if TProcessCmdId was ECmdGetValueTDes8 or ECmdGetSupportedBTProfiles

Since: S60 3.1

Parameters

const TInt aTrid	Transaction id
const TDesC8 & aCmdResponse	Response data
const TInt aErrCode	KErrNone if succesful, system-wide error code if failed.

ProcessResponse(const TInt, TPtr8 *, const TInt)

IMPORT_C void	ProcessResponse	(	const TInt	aTrid,
			TPtr8 *	aPtr,
			const TInt	aErrCode
		)

Handles responses get from ASYproxy for previously made NotifyProcessCommands() -call. ASYProxy calls this function if TProcessCmdId was ECmdGetObjectValue

Parameters

const TInt aTrid	Transaction id
TPtr8 * aPtr	Response data
const TInt aErrCode	KErrNone if succesful, system-wide error code if failed.

Member Data Documentation

TAccSrvProcessCmdIdPckg iProcessCmdIdPckg

TAccSrvProcessCmdIdPckg

iProcessCmdIdPckg

[private]

TPckg< TInt > iTransactionIDPckg

TPckg< TInt >

iTransactionIDPckg

[private]