NAME

nbd_connect_read_memory - connect to a read-only memory buffer

SYNOPSIS

 #include <libnbd.h>

 typedef struct {
   int (*callback) (void *user_data, int *error);
   void *user_data;
   void (*free) (void *user_data);
 } nbd_completion_callback;

 int nbd_connect_read_memory (
       struct nbd_handle *h, const void *buf, size_t len,
       nbd_completion_callback completion_callback
     );

DESCRIPTION

Pass a memory buffer which libnbd reads from. When the memory buffer is exhausted, libnbd acts as if the input was closed. Writes from libnbd are discarded.

This is an internal only API that is used when fuzzing libnbd, and is unlikely to be useful for ordinary callers.

The buffer must persist for the lifetime of the handle, and must not be modified, moved or freed during this time. However libnbd will not free the buffer when the handle is closed, it is still owned by the caller.

RETURN VALUE

If the call is successful the function returns 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, buf. For more information see "Non-NULL parameters" in libnbd(3).

NOTES

Blocking connect call

This call returns when the connection has been made. By default, this proceeds all the way to transmission phase, but nbd_set_opt_mode(3) can be used for manual control over option negotiation performed before transmission phase.

HANDLE STATE

nbd_connect_read_memory can be called when the handle is in the following state:

 ┌─────────────────────────────────────┬─────────────────────────┐
 │ Handle created, before connecting   │ ✅ allowed              │
 │ Connecting                          │ ❌ error                │
 │ Connecting & handshaking (opt_mode) │ ❌ error                │
 │ Connected to the server             │ ❌ error                │
 │ Connection shut down                │ ❌ error                │
 │ Handle dead                         │ ❌ error                │
 └─────────────────────────────────────┴─────────────────────────┘

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

SEE ALSO

nbd_aio_connect_read_memory(3), nbd_create(3), nbd_set_opt_mode(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