Collapse all Symbian^3 Product Developer Library

MRemConBearerBulkInterface Class Reference

class MRemConBearerBulkInterface

Mixin for the bearer API.

Public Member Functions
void	MrcbbiBulkClientAvailable(const TRemConClientId &)
void	MrcbbiBulkClientNotAvailable(const TRemConClientId &)
TInt	MrcbbiGetCommand(TUid &, TUint &, TUint &, RBuf8 &, TRemConAddress &)
void	MrcbbiSendReject(TUid, TUint, TUint, const TRemConAddress &)
TInt	MrcbbiSendResponse(TUid, TUint, TUint, RBuf8 &, const TRemConAddress &)
TInt	MrcbbiStartBulk(MRemConBearerBulkObserver &)
void	MrcbbiStopBulk()

Member Functions Documentation

MrcbbiBulkClientAvailable(const TRemConClientId &)

void

MrcbbiBulkClientAvailable

(

const TRemConClientId &

aId

)

[pure virtual]

Called by RemCon when a bulk client becomes available. The provided client ID will be shared with the associated control client.

Parameters

const TRemConClientId & aId

The ID of the bulk client that has become available.

MrcbbiBulkClientNotAvailable(const TRemConClientId &)

void

MrcbbiBulkClientNotAvailable

(

const TRemConClientId &

aId

)

[pure virtual]

Called by RemCon when a bulk client is no longer available.

Parameters

const TRemConClientId & aId

The ID of the bulk client that is no longer available.

MrcbbiGetCommand(TUid &, TUint &, TUint &, RBuf8 &, TRemConAddress &)

TInt	MrcbbiGetCommand	(	TUid &	aInterfaceUid,
			TUint &	aTransactionId,
			TUint &	aOperationId,
			RBuf8 &	aData,
			TRemConAddress &	aAddr
		)	[pure virtual]

Called by RemCon to retrieve a command on a connection. Must only be called as a result of a NewCommand up-call.

Parameters

TUid & aInterfaceUid	The UID of the outer-layer client API specifying the command.
TUint & aTransactionId	The command identifier used as a cookie for command/response matching.
TUint & aOperationId	The ID of the command operation in the outer-layer client API.
RBuf8 & aData	API-specific message data. On success, ownership is returned.
TRemConAddress & aAddr	The connection.

MrcbbiSendReject(TUid, TUint, TUint, const TRemConAddress &)

void	MrcbbiSendReject	(	TUid	aInterfaceUid,
			TUint	aOperationId,
			TUint	aTransactionId,
			const TRemConAddress &	aAddr
		)	[pure virtual]

Called by RemCon when all appropriate clients disconnect from remcon before the response is sent.

Parameters

TUid aInterfaceUid	The UID of the outer-layer client API that the command was sent to
TUint aOperationId	The ID of the command operation sent to remcon
TUint aTransactionId
const TRemConAddress & aAddr	The connection.

MrcbbiSendResponse(TUid, TUint, TUint, RBuf8 &, const TRemConAddress &)

TInt	MrcbbiSendResponse	(	TUid	aInterfaceUid,
			TUint	aOperationId,
			TUint	aTransactionId,
			RBuf8 &	aData,
			const TRemConAddress &	aAddr
		)	[pure virtual]

Called by RemCon to send a response on a connection. The connection is not assumed to exist- the bearer is responsible for bringing up the requested connection if necessary.

Parameters

TUid aInterfaceUid	The UID of the outer-layer client API specifying the response.
TUint aOperationId	The ID of the response operation in the outer-layer client API.
TUint aTransactionId	The command identifier used as a cookie for command/response matching
RBuf8 & aData	API-specific message data. On success, ownership is passed.
const TRemConAddress & aAddr	The connection.

MrcbbiStartBulk(MRemConBearerBulkObserver &)

TInt

MrcbbiStartBulk

(

MRemConBearerBulkObserver &

aObserver

)

[pure virtual]

Called by RemCon to initialise the bulk service. This call will be made in the context of the bulk server thread.

Parameters

MRemConBearerBulkObserver & aObserver

The bulk bearer observer.

MrcbbiStopBulk()

void

MrcbbiStopBulk

(

)

[pure virtual]

Called by RemCon to disable the bulk service. This call will be made in the context of the bulk server thread. The bearer should use this opportunity to cancel any outstanding bulk services.