REMCTL_CLOSE(3)

📦
version 3.18 · 3 versions
, in debian bookworm, debian trixie, epel 9, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 REMCTL_CLOSE — the "we're done here, bestie" page 💖

okay so this is remctl_close(3) from the remctl Library Reference, and honestly? it's the goodbye page. the clean-exit page. the "wrap it up, we ate, now let's not leak memory" page. 🎀

✨ NAME ✨

remctl_close — close a remctl connection and free the client object 🦋

🌸 SYNOPSIS 🌸

#include <remctl.h>

void remctl_close(struct remctl *r);

like. that's it. that's the whole signature. no return value, no drama, no hidden agenda. it's giving void and we respect it. 💅

💜 DESCRIPTION 💜

so remctl_close() does two (2) iconic things, in order, no cap:

  1. it cleanly closes any connection to a remote server that was created via remctl_open() for the given client object
  2. and then it frees the object that remctl_new() created

basically it's the reverse girlies of remctl_new() and remctl_open(). it takes the object you built and it puts it to rest. 🧚

bestie, listen. you should call this when you're finished with a remctl client object. that's literally the whole point. it's how you avoid resource leaks. do not be the person who leaks. that's not main character energy, that's just sad. 😭

and here's the important part, so pay attention fr fr:

Following the call to remctl_close(), the r pointer to the remctl client object is no longer valid.

like. it's gone. expired. deceased. do NOT touch it afterward. do not pass it to anything. do not look at it. it has left the building and it is not coming back. 💀

and the vibes on failure? there are none. remctl_close() is always successful, even if it's unable to send a clean protocol quit command to the remote server. it simply does not care. it cannot fail. it's built different. periodt. 👑

⭐ COMPATIBILITY ⭐

this interface has been provided by the remctl client library since its initial release in version 2.0. so yeah, it's been here from day one. day ONE. a founding member. an original. we stan a consistent API. 🫶

👑 AUTHOR 👑

Russ Allbery <eagle@eyrie.org>

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

(translation: use it, share it, just keep the notice and don't come for them if it breaks. standard queen behaviour. 💅)

🌈 SEE ALSO 🌈

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

and that's the page!! this was remctl_close(3) from version 3.18, dated 2022-05-09 — go free your client objects, bestie, and don't leak, ily 💖🌸🦋

📦 where this page comes from