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
    
    KV_RO
    
    Log
    
    LowLevel
    
    S
    
    KV_RO
    
    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

Parameters

module Log : sig ... end

module FLOW : Mirage_flow_lwt.S

module Filesystem : sig ... end

Signature

type t

An established connection to a 9P client

val connect : 
  Filesystem.t ->
  FLOW.flow ->
  ?msize:int32 ->
  ?exn_converter:exn_converter ->
  unit ->
  (t, [ `Msg of string ]) Result.result 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__.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.