package hvsock

You can search for identifiers within the package.

in-package search v0.2.0

Bindings for Hyper-V AF_VSOCK

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

Maintainers

D

dave@recoil.org

Sources

2.0.0.tar.gz

sha256=e94afeaa1a8bdb8ea7e5b30ffc8ed476e5999c668a48e8c8e49a6a97ceda6cc9

md5=b5512ca72cbbd01d6e756264d6114020

doc/hvsock.lwt/Hvsock_lwt/Socket/Make/index.html

Module `Socket.Make`Source

Create a Lwt socket from a

source of timing
a means of running blocking calls in full threads
a means of creating sockets

This is useful because some of the hypervisor sockets do not support select() or other methods of asynchronous I/O and we must therefore run the calls in background threads.

Parameters

module Time : Mirage_time_lwt.S

module Fn : S.FN

module Socket_family : Hvsock.Af_common.S

Signature

Sourcetype t

A socket which supports I/O via Lwt

Sourcetype sockaddr = Socket_family.sockaddr

A socket address

Sourceval string_of_sockaddr : sockaddr -> string

Sourceval create : unit -> t

create () creates an unbound hypervisorsocket

Sourcetype fd = Socket_family.t

A low-level file descriptor

Sourceval to_fd : t -> fd option

to_fd t returns the wrapped file descriptor. Note this only supports blocking I/O

Sourceval bind : t -> sockaddr -> unit

bind t sockaddr binds socket to sockaddr

Sourceval listen : t -> int -> unit

listen t queue

Sourceval accept : t -> (t * sockaddr) Lwt.t

accept t accepts a single connection

Sourceval connect : ?timeout_ms:int -> t -> sockaddr -> unit Lwt.t

connect ?timeout_ms t sockaddr connects to a remote partition

Sourceval read : t -> Cstruct.t -> int Lwt.t

read t buf reads as many bytes as available into buf returning the number of bytes read.

Sourceval write : t -> Cstruct.t -> int Lwt.t

write t buf writes as many bytes from buf to t as will currently fit inside t's internal buffer, and return the number of bytes written

Sourceval close : t -> unit Lwt.t

close t closes a socket

Sourceval shutdown_read : t -> unit Lwt.t

shutdown_read t closes the read side of the socket

Sourceval shutdown_write : t -> unit Lwt.t

shutdown_write t closes the write side of the socket

On This Page

Parameters
Signature