=head1 NAME

nbd_get_keepalive - return keepalive status

=head1 SYNOPSIS

 #include <libnbd.h>

 int nbd_get_keepalive (
       struct nbd_handle *h
     );

=head1 DESCRIPTION

Return the keepalive status.

If the handle is not connected, this returns the keepalive flag
from the handle as set by L<nbd_set_keepalive(3)>.

If the handle is connected, this attempts to read the keepalive
(C<SO_KEEPALIVE>) flag from the socket itself, telling you if
keepalive was successfully enabled or not.

=head1 RETURN VALUE

This call returns a boolean value.

=head1 ERRORS

On error C<-1> is returned.

Refer to L<libnbd(3)/ERROR HANDLING>
for how to get further details of the error.

The following parameters must not be NULL: C<h>.
For more information see L<libnbd(3)/Non-NULL parameters>.

=head1 VERSION

This function first appeared in libnbd 1.26.

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_KEEPALIVE 1

=head1 SEE ALSO

L<nbd_create(3)>,
L<nbd_set_keepalive(3)>,
L<libnbd(3)>,
L<getsockopt(2)>,
L<socket(7)>.

=head1 AUTHORS

Eric Blake

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat
