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
- 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

Parameters

module Log : Protocol_9p_s.LOG

module FLOW : Mirage_flow_lwt.S

module Filesystem : Protocol_9p_filesystem.S

Signature

type t

An established connection to a 9P client

val connect : 
  Filesystem.t ->
  FLOW.flow ->
  ?msize:int32 ->
  ?exn_converter:exn_converter ->
  unit ->
  t Protocol_9p_error.t Lwt.t

Establish a fresh connection to a 9P client. msize gives the maximum message size we support: the client may request a lower value. receive_cb will be called with every 9P request.

val get_info : t -> Protocol_9p_info.t

Return information about the current connection

val disconnect : t -> unit Lwt.t

disconnect connection causes the connection connection to close after the next message is processed. Once the connection has been disconnected, the returned thread will resolve.

val after_disconnect : t -> unit Lwt.t

after_disconnect connection resolves after connection has disconnected.