curl / libcurl / API / curl_global_init_mem

curl_global_init_mem - libcurl initialisation with memory callbacks

Name

curl_global_init_mem - Global libcurl initialisation with memory callbacks

Synopsis

#include <curl/curl.h>
 
CURLcode curl_global_init_mem(long flags,
                              curl_malloc_callback m,
                              curl_free_callback f,
                              curl_realloc_callback r,
                              curl_strdup_callback s,
                              curl_calloc_callback c);

Description

This function works exactly as curl_global_init with one addition: it allows the application to set callbacks to replace the otherwise used internal memory functions.

If you are using libcurl from multiple threads or libcurl was built with the threaded resolver option then the callback functions must be thread safe. The threaded resolver is a common build option to enable (and in some cases the default) so we strongly urge you to make your callback functions thread safe.

All callback arguments must be set to valid function pointers. The prototypes for the given callbacks must match these:

void *malloc_callback(size_t size);

To replace malloc()

void free_callback(void *ptr);

To replace free()

void *realloc_callback(void *ptr, size_t size);

To replace realloc()

char *strdup_callback(const char *str);

To replace strdup()

void *calloc_callback(size_t nmemb, size_t size);

To replace calloc()

This function is otherwise the same as curl_global_init, please refer to that man page for documentation.

Caution

Manipulating these gives considerable powers to the application to severely screw things up for libcurl. Take care!

Example

 curl_global_init_mem(CURL_GLOBAL_DEFAULT, curl_malloc_cb,
                      curl_free_cb, curl_realloc_cb,
                      curl_strdup_cb, curl_calloc_cb);

Availability

Added in 7.12.0

Return value

CURLE_OK (0) means everything was ok, non-zero means an error occurred as <curl/curl.h> defines - see libcurl-errors.

See also

curl_global_init(3), curl_global_cleanup(3),

This HTML page was made with roffit.