remctl_close(3)

remctl_close3

Close a remctl connection and free the client object

Usage

#include <remctl.h>

void remctl_close(struct remctl *r);

Overview

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.

Releases

9 releases since Debian 5.0 (Lenny); the text changed 7 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10
  7. 11
  8. 12–13

Author

Russ Allbery <[email protected]>

From libremctl-dev 3.18-3 in Debian 13 (Trixie). Parsed by carta from the page's man source.