A buffered Mirage FLOW implementation over a hypervisor socket
module Socket_family : Hvsock.Af_common.Sinclude Mirage_flow_combinators.SHUTDOWNABLE with type error := errorinclude Mirage_flow.S with type error := errorThe type for write errors.
val pp_write_error : write_error Fmt.tpp_write_error is the pretty-printer for write errors.
The type for flows. A flow represents the state of a single reliable stream that is connected to an endpoint.
val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.tread flow blocks until some data is available and returns a fresh buffer containing it.
The returned buffer will be of a size convenient to the flow implementation, but will always have at least 1 byte.
If the remote endpoint calls close then calls to read will keep returning data until all the in-flight data has been read. read flow will return `Eof when the remote endpoint has called close and when there is no more in-flight data.
val write : flow -> Cstruct.t -> (unit, write_error) Stdlib.result Lwt.twrite flow buffer writes a buffer to the flow. There is no indication when the buffer has actually been read and, therefore, it must not be reused. The contents may be transmitted in separate packets, depending on the underlying transport. The result Ok () indicates success, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.
val writev : flow -> Cstruct.t list -> (unit, write_error) Stdlib.result Lwt.twritev flow buffers writes a sequence of buffers to the flow. There is no indication when the buffers have actually been read and, therefore, they must not be reused. The result Ok () indicates success, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.
val close : flow -> unit Lwt.tclose flow flushes all pending writes and signals the remote endpoint that there will be no future writes. Once the remote endpoint has read all pending data, it is expected that calls to read on the remote return `Eof.
Note it is still possible for the remote endpoint to write to the flow and for the local endpoint to call read. This state where the local endpoint has called close but the remote endpoint has not called close is similar to that of a half-closed TCP connection or a Unix socket after shutdown(SHUTDOWN_WRITE).
close flow waits until the remote endpoint has also called close before returning. At this point no data can flow in either direction and resources associated with the flow can be freed.
val shutdown_write : flow -> unit Lwt.tClose the write direction of the flow, flushing any buffered data and causing future calls to read by the peer to return `Eof.
val shutdown_read : flow -> unit Lwt.tClose the read direction of the flow, such that future calls to write by the peer will return `Eof
module Socket : S.SOCKET with type sockaddr = Socket_family.sockaddrConstruct a flow given a hypervisor socket connection. ?message_size allows the maximum send/recv size to be limited. ?buffer_size controls how much buffering is placed over the socket.
Note the buffer handling of this flow is different to normal: `read` and `readv` will retain references to the passed buffers. They must not be used again by the calling application.
val read_into :
flow ->
Cstruct.t ->
(unit Mirage_flow.or_eof, error) Stdlib.result Lwt.t