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
|
=head1 NAME
nbd_kill_subprocess - kill server running as a subprocess
=head1 SYNOPSIS
#include <libnbd.h>
int nbd_kill_subprocess (
struct nbd_handle *h, int signum
);
=head1 DESCRIPTION
This call may be used to kill
the server running as a subprocess
that was previously created using L<nbd_connect_command(3)>. You
do not need to use this call. It is only needed if the server
does not exit when the socket is closed.
The C<signum> parameter is the optional signal number to send
(see L<signal(7)>). If C<signum> is C<0> then C<SIGTERM> is sent.
=head1 RETURN VALUE
If the call is successful the function returns C<0>.
=head1 ERRORS
On error C<-1> is returned.
Refer to L<libnbd(3)/ERROR HANDLING>
for how to get further details of the error.
The following parameters must not be NULL: C<h>.
For more information see L<libnbd(3)/Non-NULL parameters>.
=head1 VERSION
This function first appeared in libnbd 1.0.
If you need to test if this function is available at compile time
check if the following macro is defined:
#define LIBNBD_HAVE_NBD_KILL_SUBPROCESS 1
=head1 SEE ALSO
L<nbd_connect_command(3)>,
L<nbd_create(3)>,
L<nbd_get_subprocess_pid(3)>,
L<libnbd(3)>,
L<signal(7)>.
=head1 AUTHORS
Eric Blake
Richard W.M. Jones
=head1 COPYRIGHT
Copyright Red Hat
|
