1REMCTL_CLOSE(3)            remctl Library Reference            REMCTL_CLOSE(3)
2
3
4

NAME

6       remctl_close - Close a remctl connection and free the client object
7

SYNOPSIS

9       #include <remctl.h>
10
11       void remctl_close(struct remctl *r);
12

DESCRIPTION

14       remctl_close() cleanly closes any connection to a remote server created
15       via remctl_open() for the given client object and then frees the object
16       created by remctl_new().  It should be called when the caller is
17       finished with a remctl client object to avoid resource leaks.
18       Following the call to remctl_close(), the r pointer to the remctl
19       client object is no longer valid.
20
21       remctl_close() is always successful, even if it is unable to send a
22       clean protocol quit command to the remote server.
23

COMPATIBILITY

25       This interface has been provided by the remctl client library since its
26       initial release in version 2.0.
27

AUTHOR

29       Russ Allbery <eagle@eyrie.org>
30

32       Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford
33       Junior University
34
35       Copying and distribution of this file, with or without modification,
36       are permitted in any medium without royalty provided the copyright
37       notice and this notice are preserved.  This file is offered as-is,
38       without any warranty.
39
40       SPDX-License-Identifier: FSFAP
41

SEE ALSO

43       remctl_new(3), remctl_open(3)
44
45       The current version of the remctl library and complete details of the
46       remctl protocol are available from its web page at
47       <https://www.eyrie.org/~eagle/software/remctl/>.
48
49
50
513.15                              2018-05-05                   REMCTL_CLOSE(3)
Impressum