processtools.h File Reference

Command line interface. More...

#include <semaphore.h>
#include <signal.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <unistd.h>

Include dependency graph for processtools.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	PROCESSINFO
struct	PROCESSINFOLIST
struct	PROCESSINFODISP
struct	PROCINFOPROC
struct	STRINGLISTENTRY

Macros
#define	PROCESSINFOLISTSIZE   10000
#define	MAXNBSUBPROCESS   50
#define	MAXNBCPU   100
#define	PROCESSINFO_NBtimer   100
#define	STRINGMAXLEN_PROCESSINFO_NAME   80
#define	STRINGMAXLEN_PROCESSINFO_SRCFUNC   200
#define	STRINGMAXLEN_PROCESSINFO_SRCFILE   200
#define	STRINGMAXLEN_PROCESSINFO_TMUXNAME   100
#define	STRINGMAXLEN_PROCESSINFO_STATUSMSG   200
#define	STRINGMAXLEN_PROCESSINFO_LOGFILENAME   250
#define	STRINGMAXLEN_PROCESSINFO_DESCRIPTION   200

Typedefs
typedef int	errno_t

Functions
PROCESSINFO *	processinfo_setup (char *pinfoname, char descriptionstring[200], char msgstring[200], const char *functionname, const char *filename, int linenumber)
errno_t	processinfo_error (PROCESSINFO *processinfo, char *errmsgstring)
errno_t	processinfo_loopstart (PROCESSINFO *processinfo)
int	processinfo_loopstep (PROCESSINFO *processinfo)
int	processinfo_compute_status (PROCESSINFO *processinfo)
PROCESSINFO *	processinfo_shm_create (const char *pname, int CTRLval)
PROCESSINFO *	processinfo_shm_link (const char *pname, int *fd)
int	processinfo_shm_close (PROCESSINFO *pinfo, int fd)
int	processinfo_cleanExit (PROCESSINFO *processinfo)
int	processinfo_SIGexit (PROCESSINFO *processinfo, int SignalNumber)
int	processinfo_WriteMessage (PROCESSINFO *processinfo, const char *msgstring)
int	processinfo_exec_start (PROCESSINFO *processinfo)
int	processinfo_exec_end (PROCESSINFO *processinfo)
int	processinfo_CatchSignals ()
int	processinfo_ProcessSignals (PROCESSINFO *processinfo)
errno_t	processinfo_CTRLscreen ()

Detailed Description

Command line interface.

Command line interface (CLI) definitions and function prototypes

Bug:

No known bugs.

Command line interface (CLI) definitions and function prototypes

Author

O. Guyon

Date

9 Jul 2017

Bug:

No known bugs.

Macro Definition Documentation

MAXNBCPU

#define MAXNBCPU   100

MAXNBSUBPROCESS

#define MAXNBSUBPROCESS   50

PROCESSINFO_NBtimer

#define PROCESSINFO_NBtimer   100

PROCESSINFOLISTSIZE

#define PROCESSINFOLISTSIZE   10000

STRINGMAXLEN_PROCESSINFO_DESCRIPTION

#define STRINGMAXLEN_PROCESSINFO_DESCRIPTION   200

STRINGMAXLEN_PROCESSINFO_LOGFILENAME

#define STRINGMAXLEN_PROCESSINFO_LOGFILENAME   250

STRINGMAXLEN_PROCESSINFO_NAME

#define STRINGMAXLEN_PROCESSINFO_NAME   80

STRINGMAXLEN_PROCESSINFO_SRCFILE

#define STRINGMAXLEN_PROCESSINFO_SRCFILE   200

STRINGMAXLEN_PROCESSINFO_SRCFUNC

#define STRINGMAXLEN_PROCESSINFO_SRCFUNC   200

STRINGMAXLEN_PROCESSINFO_STATUSMSG

#define STRINGMAXLEN_PROCESSINFO_STATUSMSG   200

STRINGMAXLEN_PROCESSINFO_TMUXNAME

#define STRINGMAXLEN_PROCESSINFO_TMUXNAME   100

Typedef Documentation

errno_t

typedef int errno_t

Function Documentation

processinfo_CatchSignals()

int processinfo_CatchSignals

(

)

processinfo_cleanExit()

int processinfo_cleanExit

(

PROCESSINFO *

processinfo

)

processinfo_compute_status()

int processinfo_compute_status

(

PROCESSINFO *

processinfo

)

processinfo_CTRLscreen()

errno_t processinfo_CTRLscreen

(

)

Purpose

Control screen for PROCESSINFO structures

Description

Relies on ncurses for display

Display

processinfo_error()

errno_t processinfo_error	(	PROCESSINFO *	processinfo,
		char *	errmsgstring
	)

processinfo_exec_end()

int processinfo_exec_end

(

PROCESSINFO *

processinfo

)

processinfo_exec_start()

int processinfo_exec_start

(

PROCESSINFO *

processinfo

)

processinfo_loopstart()

errno_t processinfo_loopstart

(

PROCESSINFO *

processinfo

)

processinfo_loopstep()

int processinfo_loopstep

(

PROCESSINFO *

processinfo

)

processinfo_ProcessSignals()

int processinfo_ProcessSignals

(

PROCESSINFO *

processinfo

)

processinfo_setup()

PROCESSINFO* processinfo_setup	(	char *	pinfoname,
		char	descriptionstring[200],
		char	msgstring[200],
		const char *	functionname,
		const char *	filename,
		int	linenumber
	)

processinfo_shm_close()

int processinfo_shm_close	(	PROCESSINFO *	pinfo,
		int	fd
	)

processinfo_shm_create()

PROCESSINFO* processinfo_shm_create	(	const char *	pname,
		int	CTRLval
	)

Create PROCESSINFO structure in shared memory

The structure holds real-time information about a process, so its status can be monitored and controlled See structure PROCESSINFO in CLLIcore.h for details

processinfo_shm_link()

PROCESSINFO* processinfo_shm_link	(	const char *	pname,
		int *	fd
	)

processinfo_SIGexit()

int processinfo_SIGexit	(	PROCESSINFO *	processinfo,
		int	SignalNumber
	)

processinfo_WriteMessage()

int processinfo_WriteMessage	(	PROCESSINFO *	processinfo,
		const char *	msgstring
	)