DTLS_set_timer_cb.3ossl 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "DTLS_SET_TIMER_CB 3ossl"
  58. .TH DTLS_SET_TIMER_CB 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. DTLS_timer_cb,
  65. DTLS_set_timer_cb
  66. \&\- Set callback for controlling DTLS timer duration
  67. .SH SYNOPSIS
  68. .IX Header "SYNOPSIS"
  69. .Vb 1
  70. \& #include <openssl/ssl.h>
  71. \&
  72. \& typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
  73. \&
  74. \& void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
  75. .Ve
  76. .SH DESCRIPTION
  77. .IX Header "DESCRIPTION"
  78. This function sets an optional callback function for controlling the
  79. timeout interval on the DTLS protocol. The callback function will be
  80. called by DTLS for every new DTLS packet that is sent.
  81. .SH "RETURN VALUES"
  82. .IX Header "RETURN VALUES"
  83. Returns void.
  84. .SH HISTORY
  85. .IX Header "HISTORY"
  86. The \fBDTLS_set_timer_cb()\fR function was added in OpenSSL 1.1.1.
  87. .SH COPYRIGHT
  88. .IX Header "COPYRIGHT"
  89. Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
  90. .PP
  91. Licensed under the Apache License 2.0 (the "License"). You may not use
  92. this file except in compliance with the License. You can obtain a copy
  93. in the file LICENSE in the source distribution or at
  94. <https://www.openssl.org/source/license.html>.