package hvsock

  1. Overview
  2. Docs

Module Hvsock.HyperkitSource

Low-level interface to the Hyperkit AF_VSOCK interface

Sourcetype port = int32

The AF_VSOCK port number

Sourcetype sockaddr = {
  1. hyperkit_path : string;
    (*

    directory containing the `connect` Unix domain socket, often $HOME/Library/Containers/com.docker.docker/Data/vms/0

    *)
  2. port : port;
}

A Hyperkit AF_VSOCK socket address

include Af_common.S with type sockaddr := sockaddr and type t = Unix.file_descr
Sourceval string_of_sockaddr : sockaddr -> string
Sourceval create : unit -> t

create () creates an unbound socket

Sourceval bind : t -> sockaddr -> unit

bind socket sockaddr binds socket to sockaddr

Sourceval listen : t -> int -> unit

listen socket queue_length sets the socket to listening mode with the given maximum queue length

Sourceval accept : t -> t * sockaddr

accept fd accepts a single connection

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

connect ?timeout_ms fd sockaddr connects to a remote socket. On Windows the raw connect call can block forever if the server is not running when the call is executed (even if the server starts up afterwards) there is a default timeout of 300ms. On timeout this will raise Unix_error(Unix.ETIMEDOUT)

Sourceval writev : t -> Cstruct.t list -> int

Write a list of buffers

Sourceval read_into : t -> Cstruct.t -> int

Read into a buffer, returning the number of bytes written

Sourceval shutdown_read : t -> unit

Close the read half of the connection

Sourceval shutdown_write : t -> unit

Close the write half of the connection

Sourceval close : t -> unit

Close both halves of the connection

OCaml

Innovation. Community. Security.