DTLSV1_GET_TIMEOUT(3SSL)

📦
version 4.0.3 · 6 versions
, in ubuntu stonking

💅 DTLSV1_GET_TIMEOUT 💅

okay bestie, this is DTLSv1_get_timeout, from the OpenSSL 3SSL manual family 🌸 — the function that tells you when your DTLS or QUIC SSL object is gonna need a lil timeout event handled. it's giving "calendar reminder, but for crypto" 📅✨

✨ NAME ✨

DTLSv1_get_timeout — figure out when a DTLS or QUIC SSL object next needs a timeout event to be handled 🕰️💖

🎀 SYNOPSIS 🎀

#include <openssl/ssl.h>

int DTLSv1_get_timeout(SSL *s, struct timeval *tv);

yes queen, that's the whole signature, memorize it, it's two lines, you got this 🫶

🌈 DESCRIPTION 🌈

so DTLSv1_get_timeout() is the function you call on a DTLS or QUIC SSL object to figure out when that object next needs to do its internal processing because time has passed. literally the "are we there yet" of TLS, no cap 🚗💨

when you call DTLSv1_get_timeout(), it writes into *tv the amount of time left before the SSL object needs to have DTLSv1_handle_timeout() called on it. clock's ticking bestie ⏳

and here's the tea on what it actually returns:

  • if the SSL object needs to be ticked immediately, then *tv gets zeroed out and the function succeeds, returning 1 🔥
  • if there's no timeout currently active, the function returns 0 💀
IMPORTANT: this function is only applicable to DTLS and QUIC objects. if you call it on literally any other kind of SSL object, it fails. not "works differently", not "returns something weird" — it fails. know your object type, bestie 😭

also lowkey important: the value that comes out of a DTLSv1_get_timeout() call may change because of other calls made to the SSL object. so don't go stashing it somewhere and treating it like a forever-truth, it's a snapshot, not a prophecy 🔮👀

once that timeout expires, you should call DTLSv1_handle_timeout() to deal with all the internal processing that's now due. for more deets on that, go read DTLSv1_handle_timeout(3) 📖✨

and one more thing bestie: SSL_get_event_timeout(3) supersedes all use cases for this function, and you can use it instead. so this one's a legacy icon, an OG, but the new girl is running things now 👑

👑 RETURN VALUES 👑

  • on success: writes a duration to *tv and returns 1 💖
  • returns 0 on failure, or if no timeout is currently active 🫠

that's it. two outcomes. 1 or 0. binary queen 💅

🦋 SEE ALSO 🦋

go read these, they're the supporting cast and they ate 🌟

Copyright 2023-2026 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>.

okay that's the whole page babes, every single flag, return value and copyright line intact, nothing skipped, nothing invented 🌸 and for the cute sign-off: this absolute masterpiece of documentation is from OpenSSL 4.0.3, dated 2026-09-29, and it's the DTLSV1_GET_TIMEOUT(3SSL) page 💖✨ slay, now go call SSL_get_event_timeout(3) instead 🎀

📦 where this page comes from