VICI::stub::InterpreterStub Class Reference

A stub version of the Interpreter module. More...

#include <vici/libifstubs.h>

Inheritance diagram for VICI::stub::InterpreterStub:

Public Member Functions
	InterpreterStub (Sec::Secure *s)
	Constructor. More...
virtual void	addClient (Interp::InterpreterClient *sc)
	add a client for notifications
virtual void	debugMode (bool)
	enable debug mode More...
virtual void	setScript (csr filename)
	the XML VICI script to execute
virtual void	setArgs (ArgList args)
	set the program options
virtual void	setValue (csr varName, csr value)
	this is called when a variable has its value changed by the user More...
virtual void	setPosn (ThreadId, NodeId)
	call this to set the point where execution resumes More...
virtual void	setInterval (double secs)
	set the time interval between executing commands More...
virtual void	setBreak (NodeId, bool)
	call this to mark a node as a break point More...
virtual int	openDisplay (NodeId)
	open a Display object for reading More...
virtual void	dataAck (NodeId)
	call this after responding to InterpreterClient::dataReady() to wait for the next set of data. More...
virtual void	step (ThreadId)
virtual void	resume ()
	resume a paused script
virtual void	run ()
	start running the script
virtual void	run (csr funcName)
	start running the script at a specified function More...
virtual void	pause ()
	pause the script
virtual void	kill ()
	stop the script
virtual int	result ()
	get the exit code
virtual void	saveSnapshot (csr filename)
	save a snapshot file More...
virtual void	loadSnapshot (csr filename)
	restore a snapshot file More...
Public Member Functions inherited from VICI::Interp::Interpreter
virtual	~Interpreter ()
	virtual destructor

Additional Inherited Members
Static Public Attributes inherited from VICI::Interp::Interpreter
static const NodeId	OutDisplay = -1
	the node id of the default output display
static const NodeId	ErrDisplay = -2
	the node id of the default error display

Detailed Description

A stub version of the Interpreter module.

Constructor & Destructor Documentation

InterpreterStub::InterpreterStub

(

Sec::Secure *

s

)

Constructor.

Parameters

s	The security module.

Member Function Documentation

void InterpreterStub::dataAck ( NodeId  node )

virtual

call this after responding to InterpreterClient::dataReady() to wait for the next set of data.

Parameters

node	the node id of the display that is being acknowledged.

Implements VICI::Interp::Interpreter.

void InterpreterStub::debugMode ( bool  mode )

virtual

enable debug mode

turning this on causes events to be generated at each step of the processing.

Parameters

mode	set this true to enable debugging mode

Implements VICI::Interp::Interpreter.

void InterpreterStub::loadSnapshot ( csr  filename )

virtual

restore a snapshot file

Parameters

filename

the name of the file to load the state from

Implements VICI::Interp::Interpreter.

int InterpreterStub::openDisplay ( NodeId  node )

virtual

open a Display object for reading

the InterpreterClient::dataReady() will be called when the file descriptor has data to be read.

Parameters

node	the display object to open

Returns

file descriptor of the display object

Implements VICI::Interp::Interpreter.

void InterpreterStub::run ( csr  functionName )

virtual

start running the script at a specified function

Parameters

functionName

the function to start

Implements VICI::Interp::Interpreter.

void InterpreterStub::saveSnapshot ( csr  filename )

virtual

save a snapshot file

Parameters

filename

the name of the file to save the interpreter state to

Implements VICI::Interp::Interpreter.

void InterpreterStub::setBreak ( NodeId  node, bool  set  )

virtual

call this to mark a node as a break point

Parameters

node	The node to break execution on when reached
set	True to set the breakpoint and false to clear it.

Implements VICI::Interp::Interpreter.

void InterpreterStub::setInterval ( double  secs )

virtual

set the time interval between executing commands

Parameters

secs	the interval to wait between executing commands

Implements VICI::Interp::Interpreter.

void InterpreterStub::setPosn ( ThreadId  tid, NodeId  node  )

virtual

call this to set the point where execution resumes

Parameters

tid	the execution thread to be repositioned
node	the place to resume execution

Implements VICI::Interp::Interpreter.

void InterpreterStub::setValue ( csr  varName, csr  value  )

virtual

this is called when a variable has its value changed by the user

Parameters

varName	the variable being changed
value	the new value to assign to the variable

Implements VICI::Interp::Interpreter.

void InterpreterStub::step ( ThreadId  tid )

virtual

Parameters

tid	the thread to execute one command from

Implements VICI::Interp::Interpreter.

---

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

• libifstubs.h
• libifstubs.cpp