process.h File Reference

#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/bufferedio.h>
#include <gwenhywfar/error.h>

Go to the source code of this file.

Defines

#define GWEN_PROCESS_FLAGS_DEFAULT   0
#define GWEN_PROCESS_FLAGS_REDIR_STDERR   0x00000004
#define GWEN_PROCESS_FLAGS_REDIR_STDIN   0x00000001
#define GWEN_PROCESS_FLAGS_REDIR_STDOUT   0x00000002

Typedefs

typedef struct GWEN_PROCESS GWEN_PROCESS

Enumerations

enum  GWEN_PROCESS_STATE {
  GWEN_ProcessStateNotStarted = 0, GWEN_ProcessStateRunning, GWEN_ProcessStateExited, GWEN_ProcessStateAborted,
  GWEN_ProcessStateStopped, GWEN_ProcessStateUnknown
}

Functions

GWENHYWFAR_API void GWEN_Process_AddFlags (GWEN_PROCESS *pr, uint32_t f)
GWENHYWFAR_API GWEN_PROCESS_STATE GWEN_Process_CheckState (GWEN_PROCESS *pr)
GWENHYWFAR_API void GWEN_Process_free (GWEN_PROCESS *pr)
GWENHYWFAR_API uint32_t GWEN_Process_GetFlags (const GWEN_PROCESS *pr)
GWENHYWFAR_API int GWEN_Process_GetResult (GWEN_PROCESS *pr)
GWENHYWFAR_API GWEN_BUFFEREDIOGWEN_Process_GetStderr (const GWEN_PROCESS *pr)
GWENHYWFAR_API GWEN_BUFFEREDIOGWEN_Process_GetStdin (const GWEN_PROCESS *pr)
GWENHYWFAR_API GWEN_BUFFEREDIOGWEN_Process_GetStdout (const GWEN_PROCESS *pr)
GWENHYWFAR_API GWEN_PROCESSGWEN_Process_new ()
GWENHYWFAR_API void GWEN_Process_SetFlags (GWEN_PROCESS *pr, uint32_t f)
GWENHYWFAR_API GWEN_PROCESS_STATE GWEN_Process_Start (GWEN_PROCESS *pr, const char *prg, const char *args)
GWENHYWFAR_API void GWEN_Process_SubFlags (GWEN_PROCESS *pr, uint32_t f)
GWENHYWFAR_API int GWEN_Process_Terminate (GWEN_PROCESS *pr)
GWENHYWFAR_API int GWEN_Process_Wait (GWEN_PROCESS *pr)


Define Documentation

#define GWEN_PROCESS_FLAGS_DEFAULT   0

Definition at line 45 of file process.h.

#define GWEN_PROCESS_FLAGS_REDIR_STDERR   0x00000004

redirect the child processes stderr channel

Definition at line 43 of file process.h.

#define GWEN_PROCESS_FLAGS_REDIR_STDIN   0x00000001

redirect the child processes stdin channel

Definition at line 39 of file process.h.

#define GWEN_PROCESS_FLAGS_REDIR_STDOUT   0x00000002

redirect the child processes stdout channel

Definition at line 41 of file process.h.


Typedef Documentation

typedef struct GWEN_PROCESS GWEN_PROCESS

Definition at line 52 of file process.h.


Enumeration Type Documentation

States a process can assume.

Enumerator:
GWEN_ProcessStateNotStarted  process has not yet been started
GWEN_ProcessStateRunning  process is running
GWEN_ProcessStateExited  process exited normally
GWEN_ProcessStateAborted  process terminated abnormally (on POSIX systems this is in most cases an uncaught signal)
GWEN_ProcessStateStopped  process has been stopped (unused for now)
GWEN_ProcessStateUnknown  process is in an unknown state

Definition at line 57 of file process.h.


Function Documentation

GWENHYWFAR_API void GWEN_Process_AddFlags ( GWEN_PROCESS pr,
uint32_t  f 
)

Adds the given flag to the current process flags (see GWEN_PROCESS_FLAGS_REDIR_STDOUT and others)

GWENHYWFAR_API GWEN_PROCESS_STATE GWEN_Process_CheckState ( GWEN_PROCESS pr  ) 

Checks for the current state of the given process.

GWENHYWFAR_API void GWEN_Process_free ( GWEN_PROCESS pr  ) 

Frees process data. This does not stop the process represented by this data. You should only free this data after the process has terminated or if you are not interested in the result of the process (because after freeing this data there is no way to communicate with the process).

GWENHYWFAR_API uint32_t GWEN_Process_GetFlags ( const GWEN_PROCESS pr  ) 

Returns the current process flags (see GWEN_PROCESS_FLAGS_REDIR_STDOUT and others)

GWENHYWFAR_API int GWEN_Process_GetResult ( GWEN_PROCESS pr  ) 

Returns the result of a process. This process must have terminated in order to return a result.

GWENHYWFAR_API GWEN_BUFFEREDIO* GWEN_Process_GetStderr ( const GWEN_PROCESS pr  ) 

Returns a GWEN_BUFFEREDIO which can be used to read data written by the process via stderr. Returns 0 if the process does not have the flag GWEN_PROCESS_FLAGS_REDIR_STDERR set.

GWENHYWFAR_API GWEN_BUFFEREDIO* GWEN_Process_GetStdin ( const GWEN_PROCESS pr  ) 

Returns a GWEN_BUFFEREDIO which can be used to write data to be received by the process via stdin. Returns 0 if the process does not have the flag GWEN_PROCESS_FLAGS_REDIR_STDIN set.

GWENHYWFAR_API GWEN_BUFFEREDIO* GWEN_Process_GetStdout ( const GWEN_PROCESS pr  ) 

Returns a GWEN_BUFFEREDIO which can be used to read data written by the process via stdout. Returns 0 if the process does not have the flag GWEN_PROCESS_FLAGS_REDIR_STDOUT set.

GWENHYWFAR_API GWEN_PROCESS* GWEN_Process_new (  ) 

Creates a process representation. This does not start a process, it simply prepares some data for starting a process.

GWENHYWFAR_API void GWEN_Process_SetFlags ( GWEN_PROCESS pr,
uint32_t  f 
)

Sets the process flags to the given value (see GWEN_PROCESS_FLAGS_REDIR_STDOUT and others)

GWENHYWFAR_API GWEN_PROCESS_STATE GWEN_Process_Start ( GWEN_PROCESS pr,
const char *  prg,
const char *  args 
)

Starts the given process.

Parameters:
pr pointer to process data
prg path and name of the program to start
args command line arguments for the program (MUST NOT contain the name of the program)

GWENHYWFAR_API void GWEN_Process_SubFlags ( GWEN_PROCESS pr,
uint32_t  f 
)

Removes the given flag from the current process flags (see GWEN_PROCESS_FLAGS_REDIR_STDOUT and others)

GWENHYWFAR_API int GWEN_Process_Terminate ( GWEN_PROCESS pr  ) 

Terminates a process immediately (on POSIX systems this is performed by sending a KILL signal). This function waits for the process to terminate.

GWENHYWFAR_API int GWEN_Process_Wait ( GWEN_PROCESS pr  ) 

Waits for the termination of the given process.


Generated on Thu Aug 20 13:54:41 2009 for gwenhywfar by  doxygen 1.5.9