RGenConAgentDialogServer Class Reference

#include <agentdialog.h>

Link against: agentdialog.lib

class RGenConAgentDialogServer : public RSessionBase

Inherits from

  • RGenConAgentDialogServer
    Public Member Functions
    RGenConAgentDialogServer()
    ~RGenConAgentDialogServer()
    IMPORT_C voidAccessPointConnection(TUint32 &, TInt, TRequestStatus &)
    IMPORT_C voidAccessPointConnection(TUint32 &, TUint32, TUint32 &, TUint32, TRequestStatus &)
    IMPORT_C voidAuthenticate(TDes &, TDes &, TBool, TRequestStatus &)
    IMPORT_C voidCancelAccessPointConnection()
    IMPORT_C voidCancelAuthenticate()
    IMPORT_C voidCancelDestroyPctNotification()
    IMPORT_C voidCancelIapConnection()
    IMPORT_C voidCancelLogin()
    IMPORT_C voidCancelModemAndLocationSelection()
    IMPORT_C voidCancelQoSWarning()
    IMPORT_C voidCancelReadPct()
    IMPORT_C voidCancelReconnect()
    IMPORT_C voidCancelWarnNewIapConnection()
    IMPORT_C voidClose()
    IMPORT_C voidClosePct()
    IMPORT_C TIntConnect()
    IMPORT_C voidDestroyPctNotification(TRequestStatus &)
    IMPORT_C voidIapConnection(TUint32 &, const TConnectionPrefs &, TRequestStatus &)
    IMPORT_C voidIapConnection(TUint32 &, const TConnectionPrefs &, TInt, TRequestStatus &)
    IMPORT_C voidLogin(TDes &, TDes &, TBool, TRequestStatus &)
    IMPORT_C voidModemAndLocationSelection(TUint32 &, TUint32 &, TRequestStatus &)
    IMPORT_C TIntOpenPct()
    IMPORT_C voidQoSWarning(TBool &, TRequestStatus &)
    IMPORT_C voidReadPct(TDes &, TRequestStatus &)
    IMPORT_C voidReconnect(TBool &, TRequestStatus &)
    IMPORT_C TVersionVersion()
    IMPORT_C voidWarnNewIapConnection(const TConnectionPrefs &, TInt, const TDesC &, TBool &, TRequestStatus &)
    IMPORT_C TIntWritePct(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_CRGenConAgentDialogServer()

    ~RGenConAgentDialogServer ( )

    IMPORT_C~RGenConAgentDialogServer()

    Destructor.

    Member Function Documentation

    AccessPointConnection ( TUint32 &, TInt, TRequestStatus & )

    IMPORT_C voidAccessPointConnection(TUint32 &aAccessPoint,
    TIntaAccessPointGroup,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aStatusAny error code, or KErrNone if no error.

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

    IMPORT_C voidAccessPointConnection(TUint32 &aAP,
    TUint32aAPType,
    TUint32 &aBearerAPInd,
    TUint32aBearerAPType,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aAPThe id of the access point.
    aBearerAPTypean optional filter parameter to limit the data displayed to the client.
    aStatusAny error code, or KErrNone if no error.

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

    IMPORT_C voidAuthenticate(TDes &aUsername,
    TDes &aPassword,
    TBoolaIsReconnect,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aUsernameUsername.
    aPasswordPassword.
    aIsReconnectWhether this is a reconnect attempt or not
    aStatusAny error code, or KErrNone if no error.

    CancelAccessPointConnection ( )

    IMPORT_C voidCancelAccessPointConnection()

    Cancels the access point selection dialog.

    CancelAuthenticate ( )

    IMPORT_C voidCancelAuthenticate()

    Cancels the authentication.

    panic
    ESvrCancelReturnedError.

    CancelDestroyPctNotification ( )

    IMPORT_C voidCancelDestroyPctNotification()

    Cancels the Destroy Post Connect Terminal Notification request.

    panic
    ESvrCancelReturnedError cancel Pct Notification.

    CancelIapConnection ( )

    IMPORT_C voidCancelIapConnection()

    Cancels the IAP type connection dialog.

    panic
    ESvrCancelReturnedError.

    CancelLogin ( )

    IMPORT_C voidCancelLogin()

    Cancels the login dialog.

    panic
    ESvrCancelReturnedError Request Cancel for Login.

    CancelModemAndLocationSelection ( )

    IMPORT_C voidCancelModemAndLocationSelection()

    Cancels the ModemAndLocation connection dialog.

    panic
    ESvrCancelReturnedError.

    CancelQoSWarning ( )

    IMPORT_C voidCancelQoSWarning()

    Cancels the QoS warning dialog

    panic
    ESvrCancelReturnedError Request Cancel from Server.

    CancelReadPct ( )

    IMPORT_C voidCancelReadPct()

    Cancels the Read Post Connect Terminal request.

    panic
    ESvrCancelReturnedError Cancel Read Pct.

    CancelReconnect ( )

    IMPORT_C voidCancelReconnect()

    Cancels the reconnect dialog.

    panic
    ESvrCancelReturnedError Cancel Reconnect Request.

    CancelWarnNewIapConnection ( )

    IMPORT_C voidCancelWarnNewIapConnection()

    Cancels the IAP type new connection warning dialog.

    panic
    ESvrCancelReturnedError Cancel WarnNewIapConnection.

    Close ( )

    IMPORT_C voidClose()

    Reimplemented from RHandleBase::Close()

    Disconnect from the notifier server.

    ClosePct ( )

    IMPORT_C voidClosePct()

    Closes the Post Connect Terminal dialog.

    panic
    ESvrClosePctReturnedError

    Connect ( )

    IMPORT_C TIntConnect()

    Connect to the server

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

    DestroyPctNotification ( TRequestStatus & )

    IMPORT_C voidDestroyPctNotification(TRequestStatus &aStatus)

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

    ParameterDescription
    aStatusKErrNone if a cancel occurs, or error code otherwise.

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

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

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

    ParameterDescription
    aIAPThe id of the IAP service.
    aPrefsSpecifies the rank and desired direction of the connection and bearer.
    aStatusAny error code, or KErrNone if no error.

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

    IMPORT_C voidIapConnection(TUint32 &aIAP,
    const TConnectionPrefs &aPrefs,
    TIntaLastError,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aIAPThe id of the IAP service.
    aPrefsSpecifies the rank and desired direction of the connection and bearer.
    aLastErrorThe error with which previous connection failed.
    aStatusAny error code, or KErrNone if no error.

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

    IMPORT_C voidLogin(TDes &aUsername,
    TDes &aPassword,
    TBoolaIsReconnect,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aUsernameUsername.
    aPasswordPassword.
    aIsReconnectWhether this is a reconnect attempt or not
    aStatusAny error code, or KErrNone if no error.

    ModemAndLocationSelection ( TUint32 &, TUint32 &, TRequestStatus & )

    IMPORT_C voidModemAndLocationSelection(TUint32 &aModemId,
    TUint32 &aLocationId,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aModemIdThe id of of the record in the modem table to be used for data transactions
    aLocationIdThe id of the record in the location table to be used for the modem for data transactions
    aStatusAny error code, or KErrNone if no error

    OpenPct ( )

    IMPORT_C TIntOpenPct()

    Opens a Post Connect Terminal dialog.

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

    QoSWarning ( TBool &, TRequestStatus & )

    IMPORT_C voidQoSWarning(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.

    ParameterDescription
    aResponseSpecifies whether to terminate the connection or not i.e. ETrue means terminate connection
    aStatusAny error code, or KErrNone if no error.

    ReadPct ( TDes &, TRequestStatus & )

    IMPORT_C voidReadPct(TDes &aData,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aDataData entered by user.
    aStatusAny error code, or KErrNone if no error.

    Reconnect ( TBool &, TRequestStatus & )

    IMPORT_C voidReconnect(TBool &aResponse,
    TRequestStatus &aStatus
    )

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

    ParameterDescription
    aResponseSpecifies whether to reconnect or cancel the reconnection attempt.
    aStatusAny error code, or KErrNone if no error.

    Version ( )

    IMPORT_C TVersionVersion()const

    Return the client side version number.

    Returns: The API version.

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

    IMPORT_C voidWarnNewIapConnection(const TConnectionPrefs &aPrefs,
    TIntaLastError,
    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.

    ParameterDescription
    aPrefsSpecifies the rank and desired direction of the connection and bearer.
    aLastErrorThe error with which previous connection failed.
    aNewIapNameThe name of the IAP to be used for next connection.
    aResponseSpecifies whether to proceed with the connection or stop the connection attempt.
    aStatusAny error code, or KErrNone if no error.

    WritePct ( const TDesC & )

    IMPORT_C TIntWritePct(const TDesC &aData)

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

    ParameterDescription
    aDataIncoming data.

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