package protocol-9p

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package protocol-9p

protocol-9p
- Protocol_9p
  - Buffered9PReader
    
    Make
    
    FLOW
    
    Log
  - Client
    
    Make
    
    FLOW
    
    Log
    
    LowLevel
    
    S
    
    LowLevel
  - Error
  - Filesystem
    
    S
  - Infix
  - Info
  - Request
    
    Attach
    
    Auth
    
    Clunk
    
    Create
    
    Flush
    
    Open
    
    Read
    
    Remove
    
    Stat
    
    Version
    
    Walk
    
    Write
    
    Wstat
  - Response
    
    Attach
    
    Auth
    
    Clunk
    
    Create
    
    Err
    
    Flush
    
    Open
    
    Read
    
    Remove
    
    Stat
    
    Version
    
    Walk
    
    Write
    
    Wstat
  - S
    
    LOG
    
    SERIALISABLE
  - Server
    
    Make
    
    FLOW
    
    Filesystem
    
    Log
  - Types
    
    Arr
    
    T
    
    Data
    
    Fid
    
    FileMode
    
    Int16
    
    Int32
    
    Int64
    
    Int8
    
    OpenMode
    
    Qid
    
    Stat
    
    Tag
    
    Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Given a transport (a Mirage FLOW), construct a 9P client on top.

Parameters

module Log : sig ... end

module FLOW : Mirage_flow_lwt.S

Signature

include S

type t

An established connection to a 9P server

val after_disconnect : t -> unit Lwt.t

A thread which wakes up when the connection to the server has been broken

val disconnect : t -> unit Lwt.t

Disconnect from the 9P server, but leave the underlying FLOW connected.

val create : 
  t ->
  string list ->
  string ->
  Protocol_9p__.Protocol_9p_types.FileMode.t ->
  (unit, [ `Msg of string ]) Stdlib.result Lwt.t

create t path name perm creates a new empty file name inside path with * the given permissions.

val write : 
  t ->
  string list ->
  int64 ->
  Cstruct.t ->
  (unit, [ `Msg of string ]) Stdlib.result Lwt.t

write t path offset buf writes buf to the file at path at offset offset

val read : 
  t ->
  string list ->
  int64 ->
  int32 ->
  (Cstruct.t list, [ `Msg of string ]) Stdlib.result Lwt.t

read t path offset count returns a list of buffers containing count bytes from offset offset in the file given by path

val mkdir : 
  t ->
  string list ->
  string ->
  Protocol_9p__.Protocol_9p_types.FileMode.t ->
  (unit, [ `Msg of string ]) Stdlib.result Lwt.t

mkdir t path name perm creates a new directory name inside path with * the given permissions.

val remove : t -> string list -> (unit, [ `Msg of string ]) Stdlib.result Lwt.t

remove t path removes a file or directory from the filesystem.

val readdir : 
  t ->
  string list ->
  (Protocol_9p__.Protocol_9p_types.Stat.t list, [ `Msg of string ])
    Stdlib.result
    Lwt.t

Return the contents of a named directory.

val stat : 
  t ->
  string list ->
  (Protocol_9p__.Protocol_9p_types.Stat.t, [ `Msg of string ]) Stdlib.result
    Lwt.t

Return information about a named directory or named file.

module LowLevel : sig ... end

The functions in this module are mapped directly onto individual 9P RPCs. The client must carefully respect the rules on managing fids and stay within the message size limits.

val walk_from_root : 
  t ->
  Protocol_9p__.Protocol_9p_types.Fid.t ->
  string list ->
  (Protocol_9p__.Protocol_9p_response.Walk.t, [ `Msg of string ]) Stdlib.result
    Lwt.t

walk_from_root t is LowLevel.walk t root, where root is the internal Fid representing the root directory (which is not exposed by the API).

val with_fid : 
  t ->
  (Protocol_9p__.Protocol_9p_types.Fid.t ->
    ('a, [ `Msg of string ]) Stdlib.result Lwt.t) ->
  ('a, [ `Msg of string ]) Stdlib.result Lwt.t

with_fid t fn is the result of running fn x with a fresh Fid x, which is returned to the free pool when the thread finishes.

val connect : 
  FLOW.flow ->
  ?msize:int32 ->
  ?username:string ->
  ?max_fids:int32 ->
  ?aname:string ->
  unit ->
  (t, [ `Msg of string ]) Stdlib.result Lwt.t

Establish a fresh connection to a 9P server. msize gives the maximum message size we support: the server may choose a lower value. username is the username to present to the remote server. max_fids is the default number of maximum openened fids: by default it is set to 100. aname is the name of the exported filesystem.