Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

MPuttyClient Class Reference

The PuTTY client interface class. More...

#include <puttyclient.h>

Inheritance diagram for MPuttyClient:

CPuttyAppUi List of all members.

Public Types

enum  THostKeyResponse { EAbadonConnection, EAcceptTemporarily, EAcceptAndStore }
 Host key prompt responses. More...

enum  TCipherDirection { EBothDirections, EClientToServer, EServerToClient }
 Cipher warning communication direction. More...


Public Methods

virtual void DrawText (TInt aX, TInt aY, const TDesC &aText, TBool aBold, TBool aUnderline, TRgb aForeground, TRgb aBackground)=0
 Draws text on the terminal window.

virtual void ConnectionError (const TDesC &aMessage)=0
 Reports a connection error to the user.

virtual void FatalError (const TDesC &aMessage)=0
 Reports a fatal error to the user.

virtual void ConnectionClosed ()=0
 Reports that the connection has been closed normally.

virtual THostKeyResponse UnknownHostKey (const TDesC &aFingerprint)=0
 Prompts the user to accept or reject an unknown host key.

virtual THostKeyResponse DifferentHostKey (const TDesC &aFingerprint)=0
 Prompts the user to accept or reject a changed host key.

virtual TBool AcceptCipher (const TDesC &aCipherName, TCipherDirection aDirection)=0
 Prompts the user to accept or reject a cipher below the warning threshold.


Detailed Description

The PuTTY client interface class.

The client interface is implemented by the user-interface application, and used by the engine to send information back to the client.


Member Enumeration Documentation

enum MPuttyClient::TCipherDirection
 

Cipher warning communication direction.

Enumeration values:
EBothDirections  The cipher is used for both directions.
EClientToServer  The cipher is used client->server.
EServerToClient  The cipher is used server->client.

enum MPuttyClient::THostKeyResponse
 

Host key prompt responses.

Enumeration values:
EAbadonConnection  Abadon the connection and do not accept the key.
EAcceptTemporarily  Accept the key for this session.
EAcceptAndStore  Accept the key and store it for future use.


Member Function Documentation

virtual TBool MPuttyClient::AcceptCipher const TDesC &    aCipherName,
TCipherDirection    aDirection
[pure virtual]
 

Prompts the user to accept or reject a cipher below the warning threshold.

Parameters:
aCipherName  The cipher name
aDirection  The cipher usage direction
Returns:
ETrue if the cipher is accepted
See also:
TCipherDirection

Implemented in CPuttyAppUi.

virtual void MPuttyClient::ConnectionError const TDesC &    aMessage [pure virtual]
 

Reports a connection error to the user.

After displaying the message, the engine must be re-initialized

Parameters:
aMessage  The error message

Implemented in CPuttyAppUi.

virtual THostKeyResponse MPuttyClient::DifferentHostKey const TDesC &    aFingerprint [pure virtual]
 

Prompts the user to accept or reject a changed host key.

The method must display the key fingerprint to the user, and ask whether it should be accepted once, accepted permanently or rejected completely.

Parameters:
aFingerprint  The key fingerprint to display
Returns:
User selection
See also:
THostKeyResponse

Implemented in CPuttyAppUi.

virtual void MPuttyClient::DrawText TInt    aX,
TInt    aY,
const TDesC &    aText,
TBool    aBold,
TBool    aUnderline,
TRgb    aForeground,
TRgb    aBackground
[pure virtual]
 

Draws text on the terminal window.

The coordinates are zero-based character coordinates inside the terminal. Cursor is drawn as text with specific colors.

Parameters:
aX  Text start X-coordinate
aY  Text start X-coordinate
aText  The text to draw
aBold  Bold attribute
aUnderline  Underline attribute
aForeground  Foreground color to use
aBackground  Background color to use

Implemented in CPuttyAppUi.

virtual void MPuttyClient::FatalError const TDesC &    aMessage [pure virtual]
 

Reports a fatal error to the user.

After showing the message, the implementation must exit the program.

Parameters:
aMessage  The error message

Implemented in CPuttyAppUi.

virtual THostKeyResponse MPuttyClient::UnknownHostKey const TDesC &    aFingerprint [pure virtual]
 

Prompts the user to accept or reject an unknown host key.

The method must display the key fingerprint to the user, and ask whether it should be accepted once, accepted permanently or rejected completely.

Parameters:
aFingerprint  The key fingerprint to display
Returns:
User selection
See also:
THostKeyResponse

Implemented in CPuttyAppUi.


The documentation for this class was generated from the following file:
Generated on Sun Feb 9 13:01:29 2003 for PuTTY by doxygen1.2.18