Legend:
Library
Module
Module type
Parameter
Class
Class type
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 Mirage_block_lwt.S
with type error =
[ Mirage_block.error | `Protocol_error of Nbd.Protocol.Error.t ]
and type write_error =
[ Mirage_block.write_error | `Protocol_error of Nbd.Protocol.Error.t ]
val pp_error : error Fmt.t
type write_error = [
| `Disconnected
| `Is_read_only
| `Protocol_error of Protocol.Error.t
| `Unimplemented
]
val pp_write_error : write_error Fmt.t
val read :
t ->
int64 ->
page_aligned_buffer list ->
(unit, error) Stdlib.result io
val write :
t ->
int64 ->
page_aligned_buffer list ->
(unit, write_error) Stdlib.result io
val list :
Channel.channel ->
(string list, [ `Policy | `Unsupported ]) Result.result 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