FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kProcess.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PROCESS_H
9 #define K_FIRESYNC_PROCESS_H
10 
11 #include <kFireSync/kFsDef.h>
12 
13 kBeginHeader()
14 
15 
22 //typedef kObject kProcess; --forward-declared in kFsDef.x.h
23 
24 
30 typedef k32s kIoSource;
31 
33 #define kIOSOURCE_STDOUT (1)
34 #define kIOSOURCE_STDERR (2)
35 #define kIOSOURCE_STDIN (3)
36 
49 typedef kStatus (kCall* kProcessOutputFx)(kPointer receiver, kObject sender, const void* output, kSize size, kIoSource source);
50 
67 kFsFx(kStatus) kProcess_Construct(kProcess* process, const kChar* path, kAlloc allocator);
68 
77 kFsFx(kStatus) kProcess_AddArgument(kProcess process, const kChar* argument);
78 
87 
96 
104 kFsFx(kBool) kProcess_IsAlive(kProcess process);
105 
116 kFsFx(kStatus) kProcess_SetOutputFunction(kProcess process, kProcessOutputFx function, kPointer receiver);
117 
127 kFsFx(kStatus) kProcess_Write(kProcess process, const void* buffer, kSize count);
128 
136 kFsFx(kStatus) kProcess_Terminate(kProcess process);
137 
138 kEndHeader()
139 
140 #include <kFireSync/Utils/kProcess.x.h>
141 
142 #endif
kStatus kProcess_Terminate(kProcess process)
Terminates the running process.
kStatus kProcess_Construct(kProcess *process, const kChar *path, kAlloc allocator)
Constructs a kProcess object.
kStatus(kCall * kProcessOutputFx)(kPointer receiver, kObject sender, const void *output, kSize size, kIoSource source)
Callback signature used with the kProcess_SetOutputFunction function.
Definition: kProcess.h:49
kBool kProcess_IsAlive(kProcess process)
Determines if the process is still alive.
Essential API declarations for the kFireSync library.
Io source type.
Represents a process. It allows to define multiple arguments, send input and output parsing...
kStatus kProcess_Write(kProcess process, const void *buffer, kSize count)
Writes to the process' stdin.
kStatus kProcess_AddArgument(kProcess process, const kChar *argument)
Adds an argument.
kStatus kProcess_CreateProcess(kProcess process)
Starts the new process.
kStatus kProcess_ClearArguments(kProcess process)
Deletes all arguments.
kStatus kProcess_SetOutputFunction(kProcess process, kProcessOutputFx function, kPointer receiver)
Allows to set a function which gets called every time the process sends something to stdout or stderr...