nbd_get_keepalive - Man Page
return keepalive status
Synopsis
#include <libnbd.h>
int nbd_get_keepalive (
struct nbd_handle *h
);Description
Return the keepalive status.
If the handle is not connected, this returns the keepalive flag from the handle as set by nbd_set_keepalive(3).
If the handle is connected, this attempts to read the keepalive (SO_KEEPALIVE) flag from the socket itself, telling you if keepalive was successfully enabled or not.
Return Value
This call returns a boolean value.
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.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
See Also
nbd_create(3), nbd_set_keepalive(3), libnbd(3), getsockopt(2), socket(7).
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
Referenced By
libnbd(3), nbd_set_keepalive(3).