1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file longBow_SubProcess.h
* @ingroup testing
* @brief Facilities for running and managing subprocesses.
*
*/
#ifndef LongBow_longBow_SubProcess_h
#define LongBow_longBow_SubProcess_h
#include <stdbool.h>
struct longbow_subprocess;
typedef struct longbow_subprocess LongBowSubProcess;
/**
* Start a subprocess.
*
* @param [in] path The pathname, either absolute or relative to the current directory, of the program to execute.
* @param [in] ... A NULL terminated parameter list consisting of the parameters of the executable starting at `argv[0]`.
*
* @return A pointer to a `LongBowSubProcess` instance.
*
* Example:
* @code
* {
* LongBowSubProcess *process = longBowSubProcess_Exec("/bin/pwd", "pwd", NULL);
* }
* @endcode
*
* @see longBowSubProcess_Wait
* @see longBowSubProcess_Signal
* @see longBowSubProcess_Terminate
* @see longBowSubProcess_Wait
*/
LongBowSubProcess *longBowSubProcess_Exec(const char *path, ... /*, (char *)0 */);
/**
* Destroy a `LongBowSubProcess`
*
* If the process is still running it is sent the SIGKILL signal.
*
* @param [in] subProcessPtr A pointer to a `LongBowSubProcess` instance.
*
* Example:
* @code
* {
* LongBowSubProcess *process = longBowSubProcess_Exec("/bin/pwd", "pwd", NULL);
*
* longBowSubProcess_Destroy(&process);
* }
* @endcode
*
* @see longBowSubProcess_Exec
*/
void longBowSubProcess_Destroy(LongBowSubProcess **subProcessPtr);
/**
* Send a signal to a LongBowSubProcess
*
* @param [in] subProcess The LongBowSubProcess to receive the signal.
* @param [in] signalNumber The signal to send.
*
* @return true The signal was successfully sent.
* @return false The signal was not successfully sent.
*
* Example:
* @code
* {
* longBowSubProcess_Signal(subProcess, SIGTERM);
* }
* @endcode
*
* @see longBowSubProcess_Terminate
*/
bool longBowSubProcess_Signal(LongBowSubProcess *subProcess, int signalNumber);
/**
* Send a SIGTERM to a LongBowSubProcess
*
* @param [in] subProcess The LongBowSubProcess to receive the signal.
*
* @return true The signal was successfully sent.
* @return false The signal was not successfully sent.
*
* Example:
* @code
* {
* longBowSubProcess_Signal(subProcess, SIGTERM);
* }
* @endcode
*
* @see longBowSubProcess_Terminate
*/
bool longBowSubProcess_Terminate(LongBowSubProcess *subProcess);
/**
* Wait for a `LongBowSubProcess` to stop or terminate
*
* @param [in] subProcess The LongBowSubProcess to wait for.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*
*/
void longBowSubProcess_Wait(LongBowSubProcess *subProcess);
/**
* Print a human readable representation of the given `LongBowSubProcess`.
*
* @param [in] indentation The level of indentation to use to pretty-print the output.
* @param [in] subprocess A pointer to the instance to display.
*
* Example:
* @code
* {
* LongBowSubProcess *process = longBowSubProcess_Exec("/bin/pwd", "pwd", NULL);
*
* longBowSubProcess_Display(process, 0);
*
* longBowSubProcess_Destroy(&process);
* }
* @endcode
*
*/
void longBowSubProcess_Display(const LongBowSubProcess *subprocess, int indentation);
#endif
|
