RGenConAgentDialogServer Class Reference

#include <agentdialog.h>

Link against: agentdialog.lib

class RGenConAgentDialogServer : public RSessionBase

Inherits from

RGenConAgentDialogServer

Public Member Functions
	RGenConAgentDialogServer()
	~RGenConAgentDialogServer()
IMPORT_C void	AccessPointConnection(TUint32 &, TInt, TRequestStatus &)
IMPORT_C void	AccessPointConnection(TUint32 &, TUint32, TUint32 &, TUint32, TRequestStatus &)
IMPORT_C void	Authenticate(TDes &, TDes &, TBool, TRequestStatus &)
IMPORT_C void	CancelAccessPointConnection()
IMPORT_C void	CancelAuthenticate()
IMPORT_C void	CancelDestroyPctNotification()
IMPORT_C void	CancelIapConnection()
IMPORT_C void	CancelLogin()
IMPORT_C void	CancelModemAndLocationSelection()
IMPORT_C void	CancelQoSWarning()
IMPORT_C void	CancelReadPct()
IMPORT_C void	CancelReconnect()
IMPORT_C void	CancelWarnNewIapConnection()
IMPORT_C void	Close()
IMPORT_C void	ClosePct()
IMPORT_C TInt	Connect()
IMPORT_C void	DestroyPctNotification(TRequestStatus &)
IMPORT_C void	IapConnection(TUint32 &, const TConnectionPrefs &, TRequestStatus &)
IMPORT_C void	IapConnection(TUint32 &, const TConnectionPrefs &, TInt, TRequestStatus &)
IMPORT_C void	Login(TDes &, TDes &, TBool, TRequestStatus &)
IMPORT_C void	ModemAndLocationSelection(TUint32 &, TUint32 &, TRequestStatus &)
IMPORT_C TInt	OpenPct()
IMPORT_C void	QoSWarning(TBool &, TRequestStatus &)
IMPORT_C void	ReadPct(TDes &, TRequestStatus &)
IMPORT_C void	Reconnect(TBool &, TRequestStatus &)
IMPORT_C TVersion	Version()
IMPORT_C void	WarnNewIapConnection(const TConnectionPrefs &, TInt, const TDesC &, TBool &, TRequestStatus &)
IMPORT_C TInt	WritePct(const TDesC &)

Inherited Attributes
	RHandleBase::iHandle

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Detailed Description

RGenConAgentDialogServer. This components needs to be written as a proper polymorphic DLL in JetStream.

NOTE! Although the class inherits from RSessionBase this does not mean you have to implement the API as a client server mechanism.

Constructor & Destructor Documentation

RGenConAgentDialogServer ( )

IMPORT_C

RGenConAgentDialogServer

(

)

RGenConAgentDialogServer Constructor.

~RGenConAgentDialogServer ( )

IMPORT_C

~RGenConAgentDialogServer

(

)

Destructor.

Member Function Documentation

AccessPointConnection ( TUint32 &, TInt, TRequestStatus & )

IMPORT_C void	AccessPointConnection	(	TUint32 &	aAccessPoint,
			TInt	aAccessPointGroup,
			TRequestStatus &	aStatus
		)

Shows a connection dialog when connection preference is of an AP type.

Parameter	Description
aStatus	Any error code, or KErrNone if no error.

AccessPointConnection ( TUint32 &, TUint32, TUint32 &, TUint32, TRequestStatus & )

IMPORT_C void	AccessPointConnection	(	TUint32 &	aAP,
			TUint32	aAPType,
			TUint32 &	aBearerAPInd,
			TUint32	aBearerAPType,
			TRequestStatus &	aStatus
		)

Shows a connection dialog when connection preference is of an AP type filtered on bearer-related info.

Parameter	Description
aAP	The id of the access point.
aBearerAPType	an optional filter parameter to limit the data displayed to the client.
aStatus	Any error code, or KErrNone if no error.

Authenticate ( TDes &, TDes &, TBool, TRequestStatus & )

IMPORT_C void	Authenticate	(	TDes &	aUsername,
			TDes &	aPassword,
			TBool	aIsReconnect,
			TRequestStatus &	aStatus
		)

Shows an authentication dialog when the NetDial agent requests PPP authentication information.

Parameter	Description
aUsername	Username.
aPassword	Password.
aIsReconnect	Whether this is a reconnect attempt or not
aStatus	Any error code, or KErrNone if no error.

CancelAccessPointConnection ( )

IMPORT_C void

CancelAccessPointConnection

(

)

Cancels the access point selection dialog.

CancelAuthenticate ( )

IMPORT_C void

CancelAuthenticate

(

)

Cancels the authentication.

panic: ESvrCancelReturnedError.

CancelDestroyPctNotification ( )

IMPORT_C void

CancelDestroyPctNotification

(

)

Cancels the Destroy Post Connect Terminal Notification request.

panic: ESvrCancelReturnedError cancel Pct Notification.

CancelIapConnection ( )

IMPORT_C void

CancelIapConnection

(

)

Cancels the IAP type connection dialog.

panic: ESvrCancelReturnedError.

CancelLogin ( )

IMPORT_C void

CancelLogin

(

)

Cancels the login dialog.

panic: ESvrCancelReturnedError Request Cancel for Login.

CancelModemAndLocationSelection ( )

IMPORT_C void

CancelModemAndLocationSelection

(

)

Cancels the ModemAndLocation connection dialog.

panic: ESvrCancelReturnedError.

CancelQoSWarning ( )

IMPORT_C void

CancelQoSWarning

(

)

Cancels the QoS warning dialog

panic: ESvrCancelReturnedError Request Cancel from Server.

CancelReadPct ( )

IMPORT_C void

CancelReadPct

(

)

Cancels the Read Post Connect Terminal request.

panic: ESvrCancelReturnedError Cancel Read Pct.

CancelReconnect ( )

IMPORT_C void

CancelReconnect

(

)

Cancels the reconnect dialog.

panic: ESvrCancelReturnedError Cancel Reconnect Request.

CancelWarnNewIapConnection ( )

IMPORT_C void

CancelWarnNewIapConnection

(

)

Cancels the IAP type new connection warning dialog.

panic: ESvrCancelReturnedError Cancel WarnNewIapConnection.

Close ( )

IMPORT_C void

(

)

Reimplemented from RHandleBase::Close()

Disconnect from the notifier server.

ClosePct ( )

IMPORT_C void

ClosePct

(

)

Closes the Post Connect Terminal dialog.

panic: ESvrClosePctReturnedError

Connect ( )

IMPORT_C TInt

Connect

(

)

Connect to the server

Returns: KErrNone if connection succeeded and a standard error code otherwise.

DestroyPctNotification ( TRequestStatus & )

IMPORT_C void

DestroyPctNotification

(

TRequestStatus &

aStatus

)

Used by the NetDial agent to request that if the user cancels the dialog, then the dialog gives notification of this.

Parameter	Description
aStatus	KErrNone if a cancel occurs, or error code otherwise.

IapConnection ( TUint32 &, const TConnectionPrefs &, TRequestStatus & )

IMPORT_C void	IapConnection	(	TUint32 &	aIAP,
			const TConnectionPrefs &	aPrefs,
			TRequestStatus &	aStatus
		)

Shows a connection dialog when CommDb database is of IAP type.

Parameter	Description
aIAP	The id of the IAP service.
aPrefs	Specifies the rank and desired direction of the connection and bearer.
aStatus	Any error code, or KErrNone if no error.

IapConnection ( TUint32 &, const TConnectionPrefs &, TInt, TRequestStatus & )

IMPORT_C void	IapConnection	(	TUint32 &	aIAP,
			const TConnectionPrefs &	aPrefs,
			TInt	aLastError,
			TRequestStatus &	aStatus
		)

Shows a connection dialog when CommDb database is of IAP type.

Parameter	Description
aIAP	The id of the IAP service.
aPrefs	Specifies the rank and desired direction of the connection and bearer.
aLastError	The error with which previous connection failed.
aStatus	Any error code, or KErrNone if no error.

Login ( TDes &, TDes &, TBool, TRequestStatus & )

IMPORT_C void	Login	(	TDes &	aUsername,
			TDes &	aPassword,
			TBool	aIsReconnect,
			TRequestStatus &	aStatus
		)

Shows a login dialog when login information for use with a script is required any the NetDial agent.

Parameter	Description
aUsername	Username.
aPassword	Password.
aIsReconnect	Whether this is a reconnect attempt or not
aStatus	Any error code, or KErrNone if no error.

ModemAndLocationSelection ( TUint32 &, TUint32 &, TRequestStatus & )

IMPORT_C void	ModemAndLocationSelection	(	TUint32 &	aModemId,
			TUint32 &	aLocationId,
			TRequestStatus &	aStatus
		)

Shows a dialog to enable the user to choose which modem and location to use for data transactions

Parameter	Description
aModemId	The id of of the record in the modem table to be used for data transactions
aLocationId	The id of the record in the location table to be used for the modem for data transactions
aStatus	Any error code, or KErrNone if no error

OpenPct ( )

IMPORT_C TInt

OpenPct

(

)

Opens a Post Connect Terminal dialog.

Returns: Any error code, or KErrNone if no error.

QoSWarning ( TBool &, TRequestStatus & )

IMPORT_C void	QoSWarning	(	TBool &	aResponse,
			TRequestStatus &	aStatus
		)

Shows a dialog warning that the QoS of the connection has fallen below the minimum values specified in commdb. Expects a response from the dialog indicating if the connection is to be terminated.

Parameter	Description
aResponse	Specifies whether to terminate the connection or not i.e. ETrue means terminate connection
aStatus	Any error code, or KErrNone if no error.

ReadPct ( TDes &, TRequestStatus & )

IMPORT_C void	ReadPct	(	TDes &	aData,
			TRequestStatus &	aStatus
		)

Called by NetDial agent when the script indicates that user needs to enter some information.

Parameter	Description
aData	Data entered by user.
aStatus	Any error code, or KErrNone if no error.

Reconnect ( TBool &, TRequestStatus & )

IMPORT_C void	Reconnect	(	TBool &	aResponse,
			TRequestStatus &	aStatus
		)

Shows a reconnect dialog when connection has been broken during data transfer.

Parameter	Description
aResponse	Specifies whether to reconnect or cancel the reconnection attempt.
aStatus	Any error code, or KErrNone if no error.

Version ( )

IMPORT_C TVersion

Version

(

)

const

Return the client side version number.

Returns: The API version.

WarnNewIapConnection ( const TConnectionPrefs &, TInt, const TDesC &, TBool &, TRequestStatus & )

IMPORT_C void	WarnNewIapConnection	(	const TConnectionPrefs &	aPrefs,
			TInt	aLastError,
			const TDesC &	aNewIapName,
			TBool &	aResponse,
			TRequestStatus &	aStatus
		)

Shows a dialog warning when the CommDb database is of IAP type that the previous attempt to connect failed and that a new connection is to be attempted.

Parameter	Description
aPrefs	Specifies the rank and desired direction of the connection and bearer.
aLastError	The error with which previous connection failed.
aNewIapName	The name of the IAP to be used for next connection.
aResponse	Specifies whether to proceed with the connection or stop the connection attempt.
aStatus	Any error code, or KErrNone if no error.

WritePct ( const TDesC & )

IMPORT_C TInt

WritePct

(

const TDesC &

aData

)

Called by NetDial agent to write incoming data into the PCT window.

Parameter	Description
aData	Incoming data.

Returns: Any error code, or KErrNone if no error.