rGeddei::RemoteSession Class Reference
[rGeddei's core classes.]

Client for a remote Geddei session. More...

#include <remotesession.h>

Collaboration diagram for rGeddei::RemoteSession:

[legend]List of all members.

Public Member Functions
const bool	available (const QString &type)
void	deleteDomProcessor (const QString &name)
void	deleteProcessor (const QString &name)
const bool	domProcessorCreateAndAdd (const QString &name, const QString &host, const uint hostKey)
const bool	domProcessorCreateAndAdd (const QString &name)
const bool	isValid ()
void	keepAlive ()
const QString	makeUniqueProcessorName ()
const bool	newDomProcessor (const QString &subType, const QString &name)
const bool	newProcessor (const QString &type, const QString &name)
const bool	processorConnect (const QString &name, const uint bufferSize, const uint output, const QString &destHost, const uint destKey, const QString &destName, const uint destInput)
const bool	processorConnect (const QString &name, const uint bufferSize, const uint output, const QString &destName, const uint destInput)
void	processorDisconnect (const QString &name, const uint output)
void	processorDisconnectAll (const QString &name)
const bool	processorGo (const QString &name)
void	processorInit (const QString &name, const Properties &p, const QString &newName)
void	processorReset (const QString &name)
void	processorShare (const QString &name, const uint output)
void	processorSplit (const QString &name, const uint output)
void	processorStop (const QString &name)
void	processorWaitUntilDone (const QString &name)
const int	processorWaitUntilGoing (const QString &name, int &errorData)
	RemoteSession (const QString &host, const uint port=RGEDDEI_PORT)
const bool	subAvailable (const QString &type)
const int	subVersion (const QString &type)
const bool	typeAvailable (const QString &type)
const bool	typeSubAvailable (const QString &type)
const int	typeSubVersion (const QString &type)
const int	typeVersion (const QString &type)
const int	version (const QString &type)
	~RemoteSession ()
Friends
class	Keeper
class	LocalDomProcessor
class	LocalProcessor
class	RemoteDomProcessor
class	RemoteProcessor

---

Detailed Description

Client for a remote Geddei session.

Author:

Gav Wood <gav@cs.york.ac.uk>

This class partners with SessionServer in order to allow controlling of Geddei objects on one machine in one program by another program perhaps on a different machine.

The RemoteSession object acts as an intermediary base off which RemoteProcessor objects and the like may determine session-dependant data such as keys and state.

To the developer this is simply the first stop to using another host for Geddei.

---

Constructor & Destructor Documentation

rGeddei::RemoteSession::RemoteSession	(	const QString &	host,
		const uint	port = RGEDDEI_PORT
	)

Simple constructor. Creates a new session on host host . This machine must be running a compatible copy of nodeserver, and both control and data ports should by unemcumbered for proper operation.

Parameters:

	host	The fully qualified host name of the remote machine to connect to.
	port	The post of the remote machine to connect to. Default is the default Remote Geddei port, 16671.

rGeddei::RemoteSession::~RemoteSession

(

)

Default destructor.

---

Member Function Documentation

const bool rGeddei::RemoteSession::available

(

const QString &

type

)

Determine if the remote host has a particular type of Processor available for creation.

Parameters:

type

The class name of the Processor-derived type to query.

Returns:

true iff the Geddei system on the remote side is able to create a Processor-derived class type .

const bool rGeddei::RemoteSession::isValid

(

)

Check whether the session is established. This should be verified after instantiation of this class.

Returns:

true if this session is valid and ready.

const bool rGeddei::RemoteSession::subAvailable

(

const QString &

type

)

Determine if the remote host has a particular type of SubProcessor available for creation.

Parameters:

type

The class name of the SubProcessor-derived type to query.

Returns:

true iff the Geddei system on the remote side is able to create a SubProcessor-derived class type .

const int rGeddei::RemoteSession::subVersion

(

const QString &

type

)

Determine the latest version of a given SubProcessor type available on the remote host.

Parameters:

type

The class name of the SubProcessor-derived type to query.

Returns:

The latest available version of SubProcessor-derived class type .

const int rGeddei::RemoteSession::version

(

const QString &

type

)

Determine the latest version of a given Processor type available on the remote host.

Parameters:

type

The class name of the Processor-derived type to query.

Returns:

The latest available version of Processor-derived class type .

---

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

• remotesession.h
• remotesession.cpp

---