ExternalProcessFunc Class Reference

ExternalProcessFunc is a wrapper of an external exectable for multi-process scenario with shared memory. More...

#include <ExternalProcessFunc.h>

Public Member Functions
	ExternalProcessFunc (std::string executablePath, unsigned int shmSize, bool verbose)
	Construct a new External Process Func object. More...
	~ExternalProcessFunc ()
void	createShareMemory ()
	Create a Share Memory object with random id. More...
void	deleteShareMemory ()
void *	getSharedMemory ()
void	execute ()

Private Attributes
int	shmid
void *	shm = NULL
std::string	executablePath
unsigned int	shmSize
bool	verbose
key_t	sharedid

Detailed Description

ExternalProcessFunc is a wrapper of an external exectable for multi-process scenario with shared memory.

With this wrapper, the external executable can communicate with this placer process via shared memeory.

Definition at line 53 of file ExternalProcessFunc.h.

Constructor & Destructor Documentation

ExternalProcessFunc()

ExternalProcessFunc::ExternalProcessFunc ( std::string  executablePath, unsigned int  shmSize, bool  verbose  )

inline

Construct a new External Process Func object.

Parameters

executablePath	the absolute path of the external executable
shmSize	the total size of the shared memory
verbose	whether the wrapper dumps information of this invocation.

Definition at line 63 of file ExternalProcessFunc.h.

Here is the call graph for this function:

~ExternalProcessFunc()

ExternalProcessFunc::~ExternalProcessFunc ( )

inline

Definition at line 69 of file ExternalProcessFunc.h.

Here is the call graph for this function:

Member Function Documentation

createShareMemory()

void ExternalProcessFunc::createShareMemory ( )

inline

Create a Share Memory object with random id.

Definition at line 78 of file ExternalProcessFunc.h.

Referenced by ExternalProcessFunc().

Here is the caller graph for this function:

deleteShareMemory()

void ExternalProcessFunc::deleteShareMemory ( )

inline

Definition at line 98 of file ExternalProcessFunc.h.

Referenced by ~ExternalProcessFunc().

Here is the caller graph for this function:

execute()

void ExternalProcessFunc::execute ( )

inline

Definition at line 118 of file ExternalProcessFunc.h.

Here is the call graph for this function:

getSharedMemory()

void* ExternalProcessFunc::getSharedMemory ( )

inline

Definition at line 113 of file ExternalProcessFunc.h.

Member Data Documentation

executablePath

std::string ExternalProcessFunc::executablePath

private

Definition at line 129 of file ExternalProcessFunc.h.

Referenced by execute().

sharedid

key_t ExternalProcessFunc::sharedid

private

Definition at line 132 of file ExternalProcessFunc.h.

Referenced by createShareMemory(), and execute().

shm

void* ExternalProcessFunc::shm = NULL

private

Definition at line 128 of file ExternalProcessFunc.h.

Referenced by createShareMemory(), deleteShareMemory(), and getSharedMemory().

shmid

int ExternalProcessFunc::shmid

private

Definition at line 127 of file ExternalProcessFunc.h.

Referenced by createShareMemory(), and deleteShareMemory().

shmSize

unsigned int ExternalProcessFunc::shmSize

private

Definition at line 130 of file ExternalProcessFunc.h.

Referenced by createShareMemory(), and execute().

verbose

bool ExternalProcessFunc::verbose

private

Definition at line 131 of file ExternalProcessFunc.h.

Referenced by execute().

---

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

• src/lib/utils/ExternalProcessFunc.h