package protocol-9p

You can search for identifiers within the package.

in-package search v0.2.0

package protocol-9p

protocol-9p
- Protocol_9p
- Protocol_9p_buffered9PReader
  - Make
    
    FLOW
    
    Log
- Protocol_9p_client
  - Make
    
    FLOW
    
    KV_RO
    
    Log
    
    LowLevel
  - S
    
    KV_RO
    
    LowLevel
- Protocol_9p_error
- Protocol_9p_filesystem
  - S
- Protocol_9p_infix
- Protocol_9p_info
- Protocol_9p_request
  - Attach
  - Auth
  - Clunk
  - Create
  - Flush
  - Open
  - Read
  - Remove
  - Stat
  - Version
  - Walk
  - Write
  - Wstat
- Protocol_9p_response
  - Attach
  - Auth
  - Clunk
  - Create
  - Err
  - Flush
  - Open
  - Read
  - Remove
  - Stat
  - Version
  - Walk
  - Write
  - Wstat
- Protocol_9p_s
  - LOG
  - SERIALISABLE
- Protocol_9p_server
  - Make
    
    FLOW
    
    Filesystem
    
    Log
- Protocol_9p_types
  - Arr
    
    T
  - Data
  - Fid
    
    Map
    
    Set
  - FileMode
  - Int16
  - Int32
  - Int64
  - Int8
  - OpenMode
  - Qid
  - Stat
  - Tag
    
    Map
    
    Set
  - Version
protocol-9p.unix
- Client9p_unix
  - Make
    
    KV_RO
    
    Log
    
    LowLevel
- Flow_lwt_unix
- Lofs9p
- Server9p_unix
  - Make
    
    Filesystem
    
    Log

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Protocol_9p.Filesystem.S

type t

A filesystem. This is likely shared amongst many connections.

type connection

Server state associated with a particular connection. This should contain connection-local data such as cached authentication information and a private space of Fids

val connect : t -> Protocol_9p_info.t -> connection

Called after making a connection to initialise the per-connection state

val attach : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Attach.t ->
  Protocol_9p_response.Attach.t Protocol_9p_filesystem.or_error Lwt.t

val walk : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Walk.t ->
  Protocol_9p_response.Walk.t Protocol_9p_filesystem.or_error Lwt.t

val clunk : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Clunk.t ->
  Protocol_9p_response.Clunk.t Protocol_9p_filesystem.or_error Lwt.t

val open_ : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Open.t ->
  Protocol_9p_response.Open.t Protocol_9p_filesystem.or_error Lwt.t

val read : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Read.t ->
  Protocol_9p_response.Read.t Protocol_9p_filesystem.or_error Lwt.t

val stat : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Stat.t ->
  Protocol_9p_response.Stat.t Protocol_9p_filesystem.or_error Lwt.t

val create : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Create.t ->
  Protocol_9p_response.Create.t Protocol_9p_filesystem.or_error Lwt.t

val write : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Write.t ->
  Protocol_9p_response.Write.t Protocol_9p_filesystem.or_error Lwt.t

val remove : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Remove.t ->
  Protocol_9p_response.Remove.t Protocol_9p_filesystem.or_error Lwt.t

val wstat : 
  connection ->
  cancel:unit Lwt.t ->
  Protocol_9p_request.Wstat.t ->
  Protocol_9p_response.Wstat.t Protocol_9p_filesystem.or_error Lwt.t

val make : string list -> t

make root construct a filesystem which corresponds to the local Unix filesystem rooted at root