nbd_get_handle_size(3)

NAME
nbd_get_handle_size - return an estimate of the memory allocated for the handle

SYNOPSIS
 #include <libnbd.h>

 ssize_t nbd_get_handle_size (
           struct nbd_handle *h
         );

DESCRIPTION
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

SEE ALSO
nbd_create(3), libnbd(3).

AUTHORS
Eric Blake

Richard W.M. Jones

COPYRIGHT
Copyright Red Hat

LICENSE
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA