ghidra::DeregisterProgram Class Reference

Command to release all resources associated with a Program (executable) in the decompiler. More...

#include <ghidra_process.hh>

Inheritance diagram for ghidra::DeregisterProgram:

Public Member Functions
virtual void	rawAction (void)
	Perform the action of the command. More...
Public Member Functions inherited from ghidra::GhidraCommand
	GhidraCommand (void)
	Construct given i/o streams.
virtual	~GhidraCommand (void)
	Destructor.
virtual void	rawAction (void)=0
	Perform the action of the command. More...
int4	doit (void)
	Configure and execute the command, then send back results. More...

Public Attributes
int4	res
	The meta-command being issued to send back.

Private Member Functions
virtual void	loadParameters (void)
	Read parameters directing command execution. More...
virtual void	sendResult (const string &errorMsg)
	Send back response to the command. More...

Private Attributes
int4	inid
	The id of the Architecture being terminated.

Additional Inherited Members
virtual void	loadParameters (void)
	Read parameters directing command execution. More...
virtual void	sendResult (const string &errorMsg)
	Send back response to the command. More...
Protected Attributes inherited from ghidra::GhidraCommand
istream &	sin
	The input stream from the Ghidra client.
ostream &	sout
	The output stream to the Ghidra client.
ArchitectureGhidra *	ghidra
	The Architecture on which to perform the command.
int4	status
	Meta-command to system (0=wait for next command, 1=terminate process)

Detailed Description

Command to release all resources associated with a Program (executable) in the decompiler.

The command frees the ArchitectureGhidra object (recursively affecting all resources) associated with the program. A termination meta-command is issued for this process. The command expects a single string parameter encoding the id of the program.

Member Function Documentation

loadParameters()

void ghidra::DeregisterProgram::loadParameters ( void  )

privatevirtual

Read parameters directing command execution.

This method reads an id selecting the Architecture to act on, but it can be overloaded to read any set of data from the Ghidra client to configure how the command is executed. Individual parameters are read using the method protocol.

Reimplemented from ghidra::GhidraCommand.

References ghidra::GhidraCommand::ghidra, inid, ghidra::ArchitectureGhidra::readToAnyBurst(), and ghidra::GhidraCommand::sin.

rawAction()

void ghidra::DeregisterProgram::rawAction ( void  )

virtual

Perform the action of the command.

Configuration is assumed to have happened, and this object can immediately begin examining and manipulating data under the active Architecture object to perform the command.

Implements ghidra::GhidraCommand.

References ghidra::GhidraCommand::ghidra, inid, res, and ghidra::GhidraCommand::status.

sendResult()

void ghidra::DeregisterProgram::sendResult ( const string &  errorMsg )

privatevirtual

Send back response to the command.

This method can be overloaded to send back any kind of information as a string. Individual records are sent using the message protocol. If the command failed, a string describing the error is passed in.

Parameters

errorMsg

is, if not empty, the error causing the commmand to fail

Reimplemented from ghidra::GhidraCommand.

References res, ghidra::GhidraCommand::sendResult(), and ghidra::GhidraCommand::sout.

---

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

• ghidra_process.hh
• ghidra_process.cc