doc/manpages/gnutls_global_set_mem_functions.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_global_set_mem_functions" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_global_set_mem_functions \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "void gnutls_global_set_mem_functions(gnutls_alloc_function " alloc_func ", gnutls_alloc_function " secure_alloc_func ", gnutls_is_secure_function " is_secure_func ", gnutls_realloc_function " realloc_func ", gnutls_free_function " free_func ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_alloc_function alloc_func" 12
  11 it's the default memory allocation function. Like \fBmalloc()\fP.
  12 .IP "gnutls_alloc_function secure_alloc_func" 12
  13 This is the memory allocation function that will be used for sensitive data.
  14 .IP "gnutls_is_secure_function is_secure_func" 12
  15 a function that returns 0 if the memory given is not secure. May be NULL.
  16 .IP "gnutls_realloc_function realloc_func" 12
  17 A realloc function
  18 .IP "gnutls_free_function free_func" 12
  19 The function that frees allocated data. Must accept a NULL pointer.
  20 .SH "DESCRIPTION"
  21 This is the function were you set the memory allocation functions
  22 gnutls is going to use. By default the libc's allocation functions
  23 (\fBmalloc()\fP, \fBfree()\fP), are used by gnutls, to allocate both sensitive
  24 and not sensitive data.  This function is provided to set the
  25 memory allocation functions to something other than the defaults
  26
  27 This function must be called before \fBgnutls_global_init()\fP is called.
  28 This function is not thread safe.
  29 .SH "REPORTING BUGS"
  30 Report bugs to <bug-gnutls@gnu.org>.
  31 GnuTLS home page: http://www.gnu.org/software/gnutls/
  32 General help using GNU software: http://www.gnu.org/gethelp/
  33 .SH COPYRIGHT
  34 Copyright \(co 2008 Free Software Foundation.
  35 .br
  36 Copying and distribution of this file, with or without modification,
  37 are permitted in any medium without royalty provided the copyright
  38 notice and this notice are preserved.
  39 .SH "SEE ALSO"
  40 The full documentation for
  41 .B gnutls
  42 is maintained as a Texinfo manual.  If the
  43 .B info
  44 and
  45 .B gnutls
  46 programs are properly installed at your site, the command
  47 .IP
  48 .B info gnutls
  49 .PP
  50 should give you access to the complete manual.