package mirage-vnetif

  1. Overview
  2. Docs
package mirage-vnetif
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a io = 'a Lwt.t
type buffer = Cstruct.t
type id = int
type macaddr = Macaddr.t
type t
val create : ?yield:(unit -> unit io) -> ?use_async_readers:bool -> unit -> t
val register : t -> [ `Ok of id | `Error of Mirage_net.error ]
val unregister : t -> id -> unit io

Unregister the listener and callback function

val unregister_and_flush : t -> id -> unit io

Unregister the listener, then block until all callbacks return for this * id. Useful when listeners are called in async.

val mac : t -> id -> macaddr
val write : t -> id -> buffer -> (unit, Mirage_net.error) Result.result io
val writev : t -> id -> buffer list -> (unit, Mirage_net.error) Result.result io
val set_listen_fn : t -> id -> (buffer -> unit io) -> unit