=head1 NAME

nbd_connection_state - return string describing the state of the
connection

=head1 SYNOPSIS

 #include <libnbd.h>

 const char * nbd_connection_state (
                struct nbd_handle *h
              );

=head1 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.

=head1 RETURN VALUE

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

=head1 ERRORS

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

=head1 SEE ALSO

L<nbd_create(3)>,
L<libnbd(3)>.

=head1 AUTHORS

Eric Blake

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat
