Collapse all Symbian^3 Application Developer Library

RConnMonPlugin Class Reference

class RConnMonPlugin : public RSubSessionBase

RConnMonPlugin Plug-in subsession. CONNMONEXT.LIB

Inherits from

RConnMonPlugin
- RSubSessionBase

Public Member Functions
void	CancelGetQuery ()
TInt	CancelRegisterAttribute (const TUint )
void	Close ()
void	GetQuery ( TDes8 &, TRequestStatus &)
TInt	Open ( RConnectionMonitor &, const TUint )
TInt	RegisterAttribute (const TUint )
TInt	SendAttribute (const TInt , const TUint , const TInt , const TAny *, const TUint )
TInt	SendEvent (const TUint , const TAny *, const TUint )
TVersion	Version ()

Inherited Functions
	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

Member Functions Documentation

CancelGetQuery()

void

CancelGetQuery

(

)

const

Cancels the attribute request from the Connection Monitor server.

CancelRegisterAttribute(const TUint)

TInt

CancelRegisterAttribute

(

const TUint

aAttribute

)

const

Cancels the attribute registration from the Connection monitor server.

Parameters

const TUint aAttribute

Attribute identifier.

Close()

void

(

)

Closes plug-in subsession from the Connection Monitor server.

GetQuery(TDes8 &, TRequestStatus &)

void	GetQuery	(	TDes8 &	aBuffer,
			TRequestStatus &	aStatus
		)	const

Gets the next attribute request from the Connection Monitor server.

Parameters

TDes8 & aBuffer	Query record in buffer.
TRequestStatus & aStatus	On completion, KErrNone if successfull, a system-wide error code if not.

Open(RConnectionMonitor &, const TUint)

TInt	Open	(	RConnectionMonitor &	aSession,
			const TUint	aConnectionId
		)

Opens a plug-in subsession to the Connection Monitor server. It must be called before any of other methods during the subsession.

Parameters

RConnectionMonitor & aSession	Connection Monitor session (RConnectionMonitor) object.
const TUint aConnectionId	Bearer specific general connection id that identifies the plug-in. See TConnMonBearerId (rconnmon.h).

RegisterAttribute(const TUint)

TInt

RegisterAttribute

(

const TUint

aAttribute

)

const

Registers an attribute to the Connection monitor server.

Parameters

const TUint aAttribute

Attribute identifier.

SendAttribute(const TInt, const TUint, const TInt, const TAny *, const TUint)

TInt	SendAttribute	(	const TInt	aType,
			const TUint	aAttribute,
			const TInt	aRet,
			const TAny *	aValue,
			const TUint	aSize
		)	const

Sends an attribute to the Connection Monitor server.

Parameters

const TInt aType	Type of the attribute (TInt, TUint, TBool, TDes, TDes8).
const TUint aAttribute	Attribute identifier.
const TInt aRet	The plug-in return code.
const TAny * aValue	The value of the attribute.
const TUint aSize	Size of the attribute. This must not exceed 512 bytes.

SendEvent(const TUint, const TAny *, const TUint)

TInt	SendEvent	(	const TUint	aEventId,
			const TAny *	aData,
			const TUint	aSize
		)	const

Sends an event to the Connection Monitor server.

Parameters

const TUint aEventId	Event identifier.
const TAny * aData	Event data.
const TUint aSize	Size of the event data. This must not exceed 512 bytes.

Version()

TVersion

Version

(

)

const

Returns the version information.