nbd_get_handle_size3

Usage

 #include <libnbd.h>
 ssize_t nbd_get_handle_size (
           struct nbd_handle *h
         );

Overview

Return an estimate of the number of bytes allocated for the handle. The main use for this is with compacting garbage collectors which can make a more informed decision about when to free the handle with this information.

Return value

This call returns an integer size ≥ 0.

Errors

On error -1 is returned.

Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.

The following parameters must not be NULL: "h". For more information see "Non-NULL parameters" in libnbd(3).

Version

This function first appeared in libnbd 1.24.

If you need to test if this function is available at compile time check if the following macro is defined:

 #define LIBNBD_HAVE_NBD_GET_HANDLE_SIZE 1