remctl_close - Man Page

Close a remctl connection and free the client object

Synopsis

#include <remctl.h>

void remctl_close(struct remctl *r);

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 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.

Compatibility

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

Author

Russ Allbery <eagle@eyrie.org>

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 <https://www.eyrie.org/~eagle/software/remctl/>.

Referenced By

remctl(3), remctl_new(3).

2022-05-09 3.18 remctl Library Reference