nxcl::NXClientLib Class Reference

Inheritance diagram for nxcl::NXClientLib:

Public Member Functions
void	invokeNXSSH (string publicKey="supplied", string serverHost="", bool encryption=true, string key="", int port=22)
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)
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 *)
notQProcess *	getNXSSHProcess (void)
notQProcess *	getNXProxyProcess (void)
notQProcess *	getX11Process (void)
notQProcess *	getNXAuthProcess (void)
bool	getIsFinished (void)
bool	getReadyForProxy (void)
NXSession *	getSession (void)
void	setIsFinished (bool status)
void	setExternalCallbacks (NXClientLibExternalCallbacks *cb)
bool	getSessionRunning (void)

Additional Inherited Members
Public Attributes inherited from nxcl::NXClientLibBase
NXClientLibExternalCallbacks *	externalCallbacks

Detailed Description

Definition at line 149 of file nxclientlib.h.

Member Function Documentation

void nxcl::NXClientLib::allowSSHConnect

(

bool

auth

)

Passes auth to this->session.setContinue()

bool nxcl::NXClientLib::chooseResumable

(

int

n

)

Read through the nx session file, and if we find a message saying "Session: Terminating session at 'some date'" we need to set isFinished to true.

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.

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::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.

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::setCustomPath ( string  path )

inline

Sets a custom binary search path

Definition at line 191 of file nxclientlib.h.

void nxcl::NXClientLib::setPassword ( string &  pass )

inline

Set the password for NX to log in with

Definition at line 291 of file nxclientlib.h.

void nxcl::NXClientLib::setUsername ( string &  user )

inline

Set the username for NX to log in with

Definition at line 282 of file nxclientlib.h.

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::write

(

string

data

)

Overloaded to give callback data on write.

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

---

The documentation for this class was generated from the following file:

• nxclientlib.h