NAME

       nbd_connection_state - return string describing the state of the connection

SYNOPSIS

        #include <libnbd.h>

        const char * nbd_connection_state (
                       struct nbd_handle *h
                     );

DESCRIPTION

       Returns a descriptive string for the state of the connection.  This can be used for
       debugging or troubleshooting, but you should not rely on the state of connections since it
       may change in future versions.

RETURN VALUE

       This call returns a statically allocated string, valid for the lifetime of the process or
       until libnbd is unloaded by dlclose(3).  You must not try to free the string.

ERRORS

       On error "NULL" 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.0.

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

        #define LIBNBD_HAVE_NBD_CONNECTION_STATE 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