DTLSV1_GET_TIMEOUT(3ossl)

📦
version 15.1 · 2 versions
, in freebsd 15.1

💅 DTLSV1_GET_TIMEOUT — the OpenSSL manual, but make it make sense

okay so bestie, this page is DTLSv1_get_timeout(3ossl) from the OpenSSL fam — it's a libssl thing, and honestly it's giving "timekeeper energy." Let me break it down for you 🕰️✨

🦋 NAME

DTLSv1_get_timeout — the little function that tells you when a DTLS or QUIC SSL object next needs a timeout event to be handled. Basically: "hey babe, you gotta come back in this much time" 💅

✨ SYNOPSIS

#include <openssl/ssl.h>

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

that's it. that's the whole vibe check. two args, one int back. slay 🎀

💖 DESCRIPTION

so DTLSv1_get_timeout() works on a DTLS or QUIC SSL object, and its whole job is telling you when that object next needs to do some internal processing just because time passed. like, time is the main character here, and the SSL object is lowkey waiting on it 👑

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

if the SSL object needs to be ticked immediately, *tv gets zeroed and the function still succeeds — returning 1. iconic, no notes.

if there's no timeout currently active, it returns 0. that's the "we're chillin', nothing scheduled" energy 😌

ok so important: this function is only for DTLS and QUIC objects. call it on any other kind of SSL object and it just fails. not its lane, not its problem 🙈

also don't forget — the value it outputs can change as a result of other calls you make to the SSL object. so like, don't go saving that number and treating it as gospel forever, because it's not fr fr 📉

once the timeout expires, you should call DTLSv1_handle_timeout() to handle any internal processing that's due — go read DTLSv1_handle_timeout(3) for the deets 🫶

and ngl, SSL_get_event_timeout(3) supersedes all use cases for this function and can be used instead of it. so like, this one still works, but the new one ate. periodt 💀

🌸 RETURN VALUES

  • 1 on success — and it writes a duration into *tv 💖
  • 0 on failure, or if no timeout is currently active 😭

that's the whole return value situation. clean, simple, no drama.

🔥 SEE ALSO

go read them, they're all part of the lore ✨

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

and that's the page, bestie 🎀 this was version 3.5.6, dated 2026-04-07, brought to you by the DTLSV1_GET_TIMEOUT(3ossl) girlies. mwah 💋🌈

📦 where this page comes from