remctl_close

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

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.

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

Last modified and spun 2016-10-11