DTLSV1_HANDLE_TIMEOUT(3ossl)

📦
version 15.1 · 2 versions
, in freebsd 15.1

💅 DTLSV1_HANDLE_TIMEOUT 💅

okay so bestie, this is the 3ossl manual page for DTLSv1_handle_timeout, and honestly? she's a little niche diva but she does her one job gorgeously. let's get into it ✨

🌸 NAME 🌸

DTLSv1_handle_timeout — handles a pending timeout event for a DTLS or QUIC SSL object. that's it, that's the whole gig 🎀

✨ SYNOPSIS ✨

#include <openssl/ssl.h>

int DTLSv1_handle_timeout(SSL *ssl);

like, yes, she needs the whole <openssl/ssl.h> header. no shortcuts 💅

🦋 DESCRIPTION 🦋

okay so here's the vibe: DTLSv1_handle_timeout() handles any timeout events that have become pending on a DTLS or QUIC SSL object. she's the one you call when the timer's gone off and somebody's gotta deal with it 🫶

and how do you know when to call her? use DTLSv1_get_timeout(3) or SSL_get_event_timeout(3) to determine when to call DTLSv1_handle_timeout(). those are your little clock-checkers, iykyk ⭐

queen behavior only: this function is only applicable to DTLS or QUIC SSL objects. call her on any other kind of SSL object and she returns 0. not her department, not her problem 💀

and here's the tea — SSL_handle_events(3) supersedes all use cases for this function and may be used instead of it. so like, she's still iconic, but the newer girl handles everything she does. no cap 🌈

👑 RETURN VALUES 👑

  • 1 — there was a pending timeout event and it was handled successfully. slay, she ate 🔥
  • 0 — there was no pending timeout event, or the SSL object is not a DTLS or QUIC object. either way, nothing happened and that's fine 💜
  • -1 — there was a pending timeout event but it could not be handled successfully. that's the 😭 one. something went wrong, go check on it

🧚 SEE ALSO 🧚

go read those too, bestie, they're literally the context 💖

Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

aaaaand that's the page!! 💐 this one came from version 3.5.6, dated 2026-04-07, and the whole thing lives under the DTLSV1_HANDLE_TIMEOUT(3ossl) header. go forth and handle those timeouts, queen 👑💖

📦 where this page comes from