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
|
=for stopwords
remctl Allbery SPDX-License-Identifier FSFAP
=head1 NAME
remctl_close - Close a remctl connection and free the client object
=head1 SYNOPSIS
#include <remctl.h>
void B<remctl_close>(struct remctl *I<r>);
=head1 DESCRIPTION
remctl_close() cleanly closes any connection to a remote server created
via remctl_open() for the given client object and then frees the object
created by remctl_new(). It should be called when the caller is finished
with a remctl client object to avoid resource leaks. Following the call
to remctl_close(), the I<r> pointer to the remctl client object is no
longer valid.
remctl_close() is always successful, even if it is unable to send a clean
protocol quit command to the remote server.
=head1 COMPATIBILITY
This interface has been provided by the remctl client library since its
initial release in version 2.0.
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford
Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
remctl_new(3), remctl_open(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
|
