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

MPuttyEngine Class Reference

The PuTTY engine interface class. More...

#include <puttyengine.h>

Inheritance diagram for MPuttyEngine:

CPuttyEngineImp List of all members.

Public Methods

virtual void Init (MPuttyClient *aClient, const TDesC &aDataPath)=0
 Initializes the engine.

virtual void Close ()=0
 Closes the engine.

virtual Config * GetConfig ()=0
 Gets a pointer to the PuTTY configuration structure.

virtual TInt Connect ()=0
 Opens a new connection.

virtual void GetErrorMessage (TDes &aTarget)=0
 Gets the most recent error message.

virtual void Disconnect ()=0
 Closes the current connection.

virtual void SetTerminalSize (TInt aWidth, TInt aHeight)=0
 Sets the terminal window size in characters.

virtual void RePaintWindow ()=0
 Re-paints the whole terminal window.

virtual void SendKeypress (TKeyCode aCode, TUint aModifiers)=0
 Sends a keypress to the backend.

virtual void AddRandomNoise (const TDesC8 &aNoise)=0
 Adds noise to the random number pool.


Detailed Description

The PuTTY engine interface class.

The engine interface is implemented in the engine EXE, and used by the user-interface application. The application gets a pointer to the engine interface in its command-line arguments.


Member Function Documentation

virtual void MPuttyEngine::AddRandomNoise const TDesC8 &    aNoise [pure virtual]
 

Adds noise to the random number pool.

Parameters:
aNoise  Noise data

Implemented in CPuttyEngineImp.

virtual TInt MPuttyEngine::Connect   [pure virtual]
 

Opens a new connection.

Returns:
KErrNone if the connection was opened successfully, KErrGeneral if not. Use GetErrorMessage() to get the error message when the connection fails.

Implemented in CPuttyEngineImp.

virtual Config* MPuttyEngine::GetConfig   [pure virtual]
 

Gets a pointer to the PuTTY configuration structure.

The configuration can be modified before a connection is opened.

Returns:
Pointer to the PuTTY configuration

Implemented in CPuttyEngineImp.

virtual void MPuttyEngine::GetErrorMessage TDes &    aTarget [pure virtual]
 

Gets the most recent error message.

Parameters:
aTarget  Target descriptor for the message. If the descriptor is not large enough, the program will panic.

Implemented in CPuttyEngineImp.

virtual void MPuttyEngine::Init MPuttyClient   aClient,
const TDesC &    aDataPath
[pure virtual]
 

Initializes the engine.

This method must be called before any other engine methods are used.

Parameters:
aClient  A pointer to the PuTTY client object. The client gets information from the engine through callback functions.
aDataPath  The directory where PuTTY settings, random seed, and other files should be stored. Typically this is the application installation path.

Implemented in CPuttyEngineImp.

virtual void MPuttyEngine::RePaintWindow   [pure virtual]
 

Re-paints the whole terminal window.

Drawing is done by calling MPuttyClient::DrawText().

Implemented in CPuttyEngineImp.

virtual void MPuttyEngine::SendKeypress TKeyCode    aCode,
TUint    aModifiers
[pure virtual]
 

Sends a keypress to the backend.

Parameters:
aCode  Key code
aModifiers  Key modifiers (TKeyEvent::iModifiers)

Implemented in CPuttyEngineImp.

virtual void MPuttyEngine::SetTerminalSize TInt    aWidth,
TInt    aHeight
[pure virtual]
 

Sets the terminal window size in characters.

The size must match the terminal control size in the user interface.

Parameters:
aWidth  width in characters
aHeight  height in characters

Implemented in CPuttyEngineImp.


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