Blame doc/manpages/gnutls_ext_register.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_ext_register" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_ext_register \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/gnutls.h>
Packit aea12f
.sp
Packit Service 991b93
.BI "int gnutls_ext_register(const char * " name ", int " id ", gnutls_ext_parse_type_t " parse_point ", gnutls_ext_recv_func " recv_func ", gnutls_ext_send_func " send_func ", gnutls_ext_deinit_data_func " deinit_func ", gnutls_ext_pack_func " pack_func ", gnutls_ext_unpack_func " unpack_func ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "const char * name" 12
Packit aea12f
the name of the extension to register
Packit aea12f
.IP "int id" 12
Packit aea12f
the numeric TLS id of the extension
Packit Service 991b93
.IP "gnutls_ext_parse_type_t parse_point" 12
Packit aea12f
the parse type of the extension (see gnutls_ext_parse_type_t)
Packit aea12f
.IP "gnutls_ext_recv_func recv_func" 12
Packit aea12f
a function to receive the data
Packit aea12f
.IP "gnutls_ext_send_func send_func" 12
Packit aea12f
a function to send the data
Packit aea12f
.IP "gnutls_ext_deinit_data_func deinit_func" 12
Packit aea12f
a function deinitialize any private data
Packit aea12f
.IP "gnutls_ext_pack_func pack_func" 12
Packit aea12f
a function which serializes the extension's private data (used on session packing for resumption)
Packit aea12f
.IP "gnutls_ext_unpack_func unpack_func" 12
Packit aea12f
a function which will deserialize the extension's private data
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will register a new extension type. The extension will remain
Packit aea12f
registered until \fBgnutls_global_deinit()\fP is called. If the extension type
Packit aea12f
is already registered then \fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned.
Packit aea12f
Packit aea12f
Each registered extension can store temporary data into the gnutls_session_t
Packit aea12f
structure using \fBgnutls_ext_set_data()\fP, and they can be retrieved using
Packit aea12f
\fBgnutls_ext_get_data()\fP.
Packit aea12f
Packit aea12f
Any extensions registered with this function are valid for the client
Packit aea12f
and TLS1.2 server hello (or encrypted extensions for TLS1.3).
Packit aea12f
Packit aea12f
This function is not thread safe.
Packit aea12f
.SH "RETURNS"
Packit aea12f
\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code.
Packit aea12f
.SH "SINCE"
Packit aea12f
3.4.0
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP