Blame doc/functions/gnutls_ext_register

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_ext_register} (const char * @var{name}, int @var{id}, gnutls_ext_parse_type_t @var{parse_point}, gnutls_ext_recv_func @var{recv_func}, gnutls_ext_send_func @var{send_func}, gnutls_ext_deinit_data_func @var{deinit_func}, gnutls_ext_pack_func @var{pack_func}, gnutls_ext_unpack_func @var{unpack_func})
Packit Service 4684c1
@var{name}: the name of the extension to register
Packit Service 4684c1
Packit Service 4684c1
@var{id}: the numeric TLS id of the extension
Packit Service 4684c1
Packit Service 4684c1
@var{parse_point}: the parse type of the extension (see gnutls_ext_parse_type_t)
Packit Service 4684c1
Packit Service 4684c1
@var{recv_func}: a function to receive the data
Packit Service 4684c1
Packit Service 4684c1
@var{send_func}: a function to send the data
Packit Service 4684c1
Packit Service 4684c1
@var{deinit_func}: a function deinitialize any private data
Packit Service 4684c1
Packit Service 4684c1
@var{pack_func}: a function which serializes the extension's private data (used on session packing for resumption)
Packit Service 4684c1
Packit Service 4684c1
@var{unpack_func}: a function which will deserialize the extension's private data
Packit Service 4684c1
Packit Service 4684c1
This function will register a new extension type. The extension will remain
Packit Service 4684c1
registered until @code{gnutls_global_deinit()}  is called. If the extension type
Packit Service 4684c1
is already registered then @code{GNUTLS_E_ALREADY_REGISTERED}  will be returned.
Packit Service 4684c1
Packit Service 4684c1
Each registered extension can store temporary data into the gnutls_session_t
Packit Service 4684c1
structure using @code{gnutls_ext_set_data()} , and they can be retrieved using
Packit Service 4684c1
@code{gnutls_ext_get_data()} .
Packit Service 4684c1
Packit Service 4684c1
Any extensions registered with this function are valid for the client
Packit Service 4684c1
and TLS1.2 server hello (or encrypted extensions for TLS1.3).
Packit Service 4684c1
Packit Service 4684c1
This function is not thread safe.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} @code{GNUTLS_E_SUCCESS}  on success, otherwise a negative error code.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 3.4.0
Packit Service 4684c1
@end deftypefun