TLSPOOL_ASYNC_CLOSE(3)

📦 version 0.9.7, in nixos 26.05

🌸 tlspool_async_close(3) — Library Calls 🌸

💖 NAME 💖

okay so bestie, this is the tlspool_async_close(3) page from the Library Calls manual, and it does exactly what it says on the cute little tin: close the TLS Pool link and stop pending requests. 💅

✨ SYNOPSIS ✨

#include <stdbool.h>

#include <tlspool/async.h>

bool tlspool_async_close (
       struct tlspool_async_pool *pool,
       bool close_socket);

🦋 DESCRIPTION 🦋

tlspool_async_close() disconnects from the TLS Pool at the given pool as opened by tlspool_async_open(). Set the close_socket flag and the underlying socket can be closed — and bestie, that only makes sense when we are not responding to a socket close-down. 🫶

Any requests that are pending on the pool connection are cancelled and will return an error, so you can properly process the various implications of the disconnect. 😭

🧚 ASYNCHRONOUS AND EVENT-DRIVEN USE 🧚

The call to tlspool_async_close() is not itself asynchronous, let alone event-driven — no cap. But it is the point that ends many independent requests that may have been fired since tlspool_async_open() was called. So it’s giving cleanup main-character energy. ✨

🔥 RETURN VALUE 🔥

The function returns true on success or, in case of failure, it returns false and sets errno appropriately. Note that there are local extensions founded in the com_err(3) system. Error codes specific to the TLS Pool are in <tlspool/errortable.h> but other systems may also link in with the com_err(3) error system. 💜

💀 ERRORS 💀

None known to date. 🎀

👑 AUTHOR 👑

Written by Rick van Rein of OpenFortress.nl, for the ARPA2.net project. 🌟

🐛 REPORTING BUGS 🐛

For any discussion, including about bugs, please use the mailing list found on http://lists.arpa2.org/mailman/listinfo/tls-pool. 💌

Please read the software distribution's README, INSTALL and TODO files for information about the tlspool-daemon implementation status. 🫡

Copyright © 2015-2019 Rick van Rein, ARPA2.net.

ARPA2 is funded from InternetWide.org, which in turns receives donations from various funding sources with an interest in a private and secure Internet that gives users control over their online presence. This particular project has been sponsored in part by NCSC. 💖

🎀 SEE ALSO 🎀

The configuration file option socket_name influences the path at which the TLS Pool is available; this is not read by the client library, and when it differs from the default path in TLSPOOL_DEFAULT_SOCKET_PATH, this function is used to inform the client library once, before calling any of the other client functions. 🧚

The TLS Pool API is documented in the include file <tlspool/commands.h> and <tlspool/starttls.h> for C, and the tlspool.py module for Python. 🐍

Online resources may be found on the project home page, http://tlspool.arpa2.net. 🌸

xoxo, ARPA2.net — March 2019 — tlspool_async_close(3) 🫶

📦 where this page comes from