package hvsock

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package hvsock

hvsock
- Hvsock
hvsock.lwt
- Flow_lwt_hvsock
  - Make
    
    Fn
    
    Hvsock
- Flow_lwt_hvsock_shutdown
  - Make
    
    Fn
    
    Hvsock
- Lwt_hvsock
  - FN
  - HVSOCK
  - Make
    
    Fn
- Lwt_hvsock_main_thread
  - MAIN
  - Make
    
    Main
hvsock.lwt-unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Time : Mirage_time_lwt.S

module Fn : Lwt_hvsock.FN

Signature

type error = [

| `Unix of Unix.error

]

include Mirage_flow_lwt.S with type error := error

type 'a io = 'a Lwt.t

val pp_error : error Fmt.t

type write_error = private [>

| Mirage_flow.write_error

]

val pp_write_error : write_error Fmt.t

type buffer = Cstruct.t

type flow

val read : flow -> (buffer Mirage_flow.or_eof, error) Pervasives.result io

val write : flow -> buffer -> (unit, write_error) Pervasives.result io

val writev : flow -> buffer list -> (unit, write_error) Pervasives.result io

val close : flow -> unit io

module Hvsock : Lwt_hvsock.HVSOCK

val connect : ?message_size:int -> ?buffer_size:int -> Hvsock.t -> flow

Construct a flow given a Hyper-V 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) Pervasives.result Lwt.t