nxcl::NXClientLib Class Reference

Inheritance diagram for nxcl::NXClientLib:

nxcl::NXClientLibBase List of all members.
void setUsername (string &user)
void setPassword (string &pass)
void setResolution (int x, int y)
void setDepth (int depth)
void setRender (bool render)
void setSessionData (NXSessionData *)
notQProcessgetNXSSHProcess (void)
notQProcessgetNXProxyProcess (void)
notQProcessgetX11Process (void)
notQProcessgetNXAuthProcess (void)
bool getIsFinished (void)
bool getReadyForProxy (void)
NXSessiongetSession (void)
void setIsFinished (bool status)
void setExternalCallbacks (NXClientLibExternalCallbacks *cb)
bool getSessionRunning (void)
static bool deleteAllSessionfiles (void)

Public Member Functions

void invokeNXSSH (string publicKey="supplied", string serverHost="", bool encryption=true, string key="", int port=22)
void setProxy (string proxyHost, string proxyUser, string proxyPass, int proxyPort)
void write (string data)
void setCustomPath (string path)
void allowSSHConnect (bool auth)
void invokeProxy (void)
string parseSSH (string message)
bool chooseResumable (int n)
bool terminateSession (int n)
void runSession (void)
void startX11 (string resolution, string name)
bool needX11Probe (void)
void doneAuth (void)
void loginFailed (void)
void finished (void)
void readyproxy (void)
void reset (void)
void processParseStdout (void)
void processParseStderr (void)
void requestConfirmation (string msg)

Detailed Description

Definition at line 153 of file nxclientlib.h.


Member Function Documentation

void nxcl::NXClientLib::invokeNXSSH ( string  publicKey = "supplied",
string  serverHost = "",
bool  encryption = true,
string  key = "",
int  port = 22 
)

Set up data and then call this->nxsshProcess.start().

Parameters:
publicKey is the path to the ssh public key file to authenticate with. Pass "supplied" to use a new key, which you should then supply as the parameter key.
serverHost is the hostname of the NX server to connect to
encryption is whether to use an encrypted NX session
key ssh key to use for authentication of the nx user if publicKey is "supplied".
port TCP port to use for the ssh connection.

void nxcl::NXClientLib::setProxy ( string  proxyHost,
string  proxyUser,
string  proxyPass,
int  proxyPort 
)

Set proxy server settings for nxssh.

Parameters:
proxyHost is the hostname
proxyUser is the username (null if not necessary)
proxyPass is the password
proxyPort is the port

void nxcl::NXClientLib::write ( string  data  ) 

Overloaded to give callback data on write.

Writes data to this->nxsshProcess stdin and also out to the user via stdoutCallback

void nxcl::NXClientLib::setCustomPath ( string  path  )  [inline]

Sets a custom binary search path

Definition at line 210 of file nxclientlib.h.

void nxcl::NXClientLib::allowSSHConnect ( bool  auth  ) 

Passes auth to this->session.setContinue()

void nxcl::NXClientLib::invokeProxy ( void   ) 

Set up data and then call this->nxproxyProcess.start()

string nxcl::NXClientLib::parseSSH ( string  message  ) 

Parse a line of output from this->nxsshProcess. This is called when the proxy has started, or if NX authentication failed. Otherwise, this->session.parseSSH() is used.

bool nxcl::NXClientLib::chooseResumable ( int  n  ) 

Re-set the contents of this->session.sessionData with the nth choice.

Returns:
true if the nth session is resumable, false if not, or if there is no nth session.

bool nxcl::NXClientLib::terminateSession ( int  n  ) 

Re-set the contents of this->session.sessionData with the nth choice such that a terminate session message will be sent to the nxserver

Returns:
true if the nth session is terminatable, false if not, or if there is no nth session.

void nxcl::NXClientLib::requestConfirmation ( string  msg  ) 

SSH requests confirmation to go ahead with connecting (e.g. if you haven't connected to the host before)

void nxcl::NXClientLib::setUsername ( string &  user  )  [inline]

Set the username for NX to log in with

Definition at line 301 of file nxclientlib.h.

References nxcl::NXSession::setUsername().

void nxcl::NXClientLib::setPassword ( string &  pass  )  [inline]

Set the password for NX to log in with

Definition at line 310 of file nxclientlib.h.

References nxcl::NXSession::setPassword().


The documentation for this class was generated from the following file:
Generated on Mon Dec 14 17:17:26 2009 for nxcl by  doxygen 1.5.1