package xenstore

  1. Overview
  2. Docs
Xenstore protocol in pure OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (2)

Authors

  1. V
    Vincent Hanquez
  2. T
    Thomas Gazagnaire
  3. D
    Dave Scott
  4. A
    Anil Madhavapeddy
  5. V
    Vincent Bernardoff

Maintainers

  1. D
    dave@recoil.org

Sources

xenstore-2.3.0.tbz
sha256=d63c6bbcb2d3c297767d83c0a0f6dd46cecfd4e691f1cf5c5b6554445ec1b3f4
sha512=5cea990ab16ef708e53605172f708dde6ed15981cca6890939274db6efde1e5b2f9ec5c659d4d2f4115c5e0c3b69bcacc798a0d7fd5c1b75b83ddccd699de189

doc/xenstore.client/Xs_client_lwt/Client/index.html

Module Xs_client_lwt.Client

Parameters

module IO : IO

Signature

type client

A multiplexing xenstore client.

val make : unit -> client Lwt.t

make () initialises and returns a xenstore client.

val suspend : client -> unit Lwt.t

suspend () suspends the client, waiting for outstanding RPCs to be completed, cancelling all watches and causing new requests to be queued.

val resume : client -> unit Lwt.t

resume () resumes the client. The connection must be up and running again before using this function.

type handle

A handle represents a single thread's xenstore access.

val immediate : client -> (handle -> 'a Lwt.t) -> 'a Lwt.t

Access xenstore with individual operations.

val transaction : client -> (handle -> 'a Lwt.t) -> 'a Lwt.t

Access xenstore with a single transaction. On conflict the operation will be repeated.

val wait : client -> (handle -> 'a Lwt.t) -> 'a Lwt.t

Wait for some condition to become true and return a value. The function argument should throw Eagain if the condition is not met, and the condition will be re-evaluated when paths change.

val directory : handle -> string -> string list Lwt.t

directory h path returns the directory listing of path.

val read : handle -> string -> string Lwt.t

read h path returns the value at path or raises Enoent.

val write : handle -> string -> string -> unit Lwt.t

write h k v writes v at k.

val rm : handle -> string -> unit Lwt.t

rm h k removes the node k.

val mkdir : handle -> string -> unit Lwt.t

mkdir h k creates the node k with an empty value.

val setperms : handle -> string -> Xs_protocol.ACL.t -> unit Lwt.t

setperms h k acl sets the permissions of k to acl.

val debug : handle -> string list -> string list Lwt.t

debug cmd_args invokes a debug command.

val restrict : handle -> int -> unit Lwt.t

restrict h domid restricts the current connection to have only the priviledges associated with domain domid.

val getdomainpath : handle -> int -> string Lwt.t

getdomainpath domid returns the local directory of domain domid.

val watch : handle -> string -> Xs_protocol.Token.t -> unit Lwt.t

watch h path token registers a manual watch at path with token.

val unwatch : handle -> string -> Xs_protocol.Token.t -> unit Lwt.t

unwatch h path token unregisters a manual watch at path with token.

val introduce : handle -> int -> nativeint -> int -> unit Lwt.t

introduce h domid store_mfn store_port called by a toolstack to signal the construction of a new domain.

val set_target : handle -> int -> int -> unit Lwt.t

set_target h stubdom_domid domid called by a toolstack to grant stubdom_domid the permissions owned by domid.