package nbd

You can search for identifiers within the package.

in-package search v0.2.0

package nbd

nbd
- Nbd
  - Channel
  - Client
  - Mirror
    
    Make
    
    Primary
    
    Secondary
  - Mux
    
    Make
    
    R
    
    RPC
  - Nbd_result
  - Protocol
    
    Announcement
    
    ClientFlag
    
    Command
    
    DiskInfo
    
    Error
    
    ExportName
    
    GlobalFlag
    
    Negotiate
    
    NegotiateResponse
    
    Option
    
    OptionRequestHeader
    
    OptionResponse
    
    OptionResponseHeader
    
    PerExportFlag
    
    Reply
    
    Request
    
    Server
  - S
    
    CLIENT
    
    SERVER
  - Server
nbd.lwt
- Nbd_lwt_unix
  - Client
  - Server

Legend:
Library
Module
Module type
Parameter
Class
Class type

An NBD client which allows you to connect to remote disks and perform I/O.

include S.CLIENT

include V1_LWT.BLOCK with type page_aligned_buffer = Cstruct.t

type page_aligned_buffer = Cstruct.t

The type for page-aligned memory buffers.

type error = [

| `Unknown of string
(*
an undiagnosed error
*)
| `Unimplemented
(*
operation not yet implemented in the code
*)
| `Is_read_only
(*
you cannot write to a read/only instance
*)
| `Disconnected
(*
the device has been previously disconnected
*)

]

The type for IO operation errors.

include V1.DEVICE with type error := error with type 'a io = 'a Lwt.t

type 'a io = 'a Lwt.t

The type for potentially blocking I/O operation

type t

The type representing the internal state of the device

type id

This type is no longer used and will be removed once other * modules stop using it in their type signatures.

val disconnect : t -> unit io

Disconnect from the device. While this might take some time to complete, it can never result in an error.

type info = {

read_write : bool;
(*
True if we can write, false if read/only
*)
sector_size : int;
(*
Octets per sector
*)
size_sectors : int64;
(*
Total sectors per device
*)

}

Characteristics of the block device. Note some devices may be able to make themselves bigger over time.

val get_info : t -> info io

Query the characteristics of a specific block device

val read : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  [ `Error of error | `Ok of unit ] io

read device sector_start buffers returns a blocking IO operation which attempts to fill buffers with data starting at sector_start. Each of buffers must be a whole number of sectors in length. The list of buffers can be of any length.

val write : 
  t ->
  int64 ->
  page_aligned_buffer list ->
  [ `Error of error | `Ok of unit ] io

write device sector_start buffers returns a blocking IO operation which attempts to write the data contained within buffers to t starting at sector_start. When the IO operation completes then all writes have been persisted.

Once submitted, it is not possible to cancel a request and there is no timeout.

The operation may fail with:

`Unimplemented: the operation has not been implemented, no data has been written.
`Is_read_only: the device is read-only, no data has been written.
`Disconnected: the device has been disconnected at application request, an unknown amount of data has been written.
`Unknown: some other permanent, fatal error (e.g. disk is on fire), where an unknown amount of data has been written.

Each of buffers must be a whole number of sectors in length. The list of buffers can be of any length.

The data will not be copied, so the supplied buffers must not be re-used until the IO operation completes.

type size = int64

The size of a remote disk

val list : 
  Channel.channel ->
  [ `Ok of string list | `Error of [ `Policy | `Unsupported ] ] Lwt.t

list channel returns a list of exports known by the server. `Error `Policy means the server has this function disabled deliberately. `Error `Unsupported means the server is old and does not support the query function.

val negotiate : 
  Channel.channel ->
  string ->
  (t * size * Protocol.PerExportFlag.t list) Lwt.t

negotiate channel export takes an already-connected channel, performs the initial protocol negotiation and connects to the named export. Returns disk * remote disk size * flags