diff options
Diffstat (limited to 'doc/manpages/gnutls_session_supplemental_register.3')
| -rw-r--r-- | doc/manpages/gnutls_session_supplemental_register.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_session_supplemental_register.3 b/doc/manpages/gnutls_session_supplemental_register.3 new file mode 100644 index 0000000..e66f9aa --- /dev/null +++ b/doc/manpages/gnutls_session_supplemental_register.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_supplemental_register" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_supplemental_register \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_supplemental_register(gnutls_session_t " session ", const char * " name ", gnutls_supplemental_data_format_type_t " type ", gnutls_supp_recv_func " recv_func ", gnutls_supp_send_func " send_func ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +the session for which this will be registered +.IP "const char * name" 12 +the name of the supplemental data to register +.IP "gnutls_supplemental_data_format_type_t type" 12 +the type of the supplemental data format +.IP "gnutls_supp_recv_func recv_func" 12 +the function to receive the data +.IP "gnutls_supp_send_func send_func" 12 +the function to send the data +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +This function will register a new supplemental data type (rfc4680). +The registered supplemental functions will be used for that specific +session. The provided \fItype\fP must be an unassigned type in +\fBgnutls_supplemental_data_format_type_t\fP. + +If the type is already registered or handled by GnuTLS internally +\fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned. + +As supplemental data are not defined under TLS 1.3, this function will +disable TLS 1.3 support for the given session. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.5.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP |