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

CPuttyEngineImp Class Reference

PuTTY engine implementation class. More...

#include <puttyengineimp.h>

Inheritance diagram for CPuttyEngineImp:

MPuttyEngine MSocketWatcher List of all members.

Public Methods

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

virtual void Close ()
 Closes the engine.

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

virtual TInt Connect ()
 Opens a new connection.

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

virtual void Disconnect ()
 Closes the current connection.

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

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

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

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

virtual void SocketOpened ()
 Called when a socket is opened.

virtual void SocketClosed ()
 Called when a socket is closed.


Detailed Description

PuTTY engine implementation class.

Takes care of implementing the MPuttyEngine interface on top of the core PuTTY software.

See also:
MPuttyEngine


Member Function Documentation

void CPuttyEngineImp::AddRandomNoise const TDesC8 &    aNoise [virtual]
 

Adds noise to the random number pool.

Parameters:
aNoise  Noise data

Implements MPuttyEngine.

TInt CPuttyEngineImp::Connect   [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.

Implements MPuttyEngine.

Config * CPuttyEngineImp::GetConfig   [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

Implements MPuttyEngine.

void CPuttyEngineImp::GetErrorMessage TDes &    aTarget [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.

Implements MPuttyEngine.

void CPuttyEngineImp::Init MPuttyClient   aClient,
const TDesC &    aDataPath
[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.

Implements MPuttyEngine.

void CPuttyEngineImp::RePaintWindow   [virtual]
 

Re-paints the whole terminal window.

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

Implements MPuttyEngine.

void CPuttyEngineImp::SendKeypress TKeyCode    aCode,
TUint    aModifiers
[virtual]
 

Sends a keypress to the backend.

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

Implements MPuttyEngine.

void CPuttyEngineImp::SetTerminalSize TInt    aWidth,
TInt    aHeight
[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

Implements MPuttyEngine.


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