package colombe

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package colombe

colombe
- Colombe
  - Decoder
  - Domain
    
    Parser
    
    Peano
  - Encoder
  - Forward_path
    
    Encoder
    
    Parser
  - Path
    
    Encoder
    
    Parser
  - Reply
    
    Decoder
    
    Encoder
  - Request
    
    Decoder
    
    Encoder
  - Reverse_path
    
    Encoder
    
    Parser
  - Rfc1869
    
    CLIENT
    
    Injection
    
    X
    
    S
  - Sigs
    
    FUNCTOR
    
    Make
    
    T
    
    X
  - State
    
    Make
    
    Protocol
    
    State
    
    PROTOCOL
colombe.auth
- Auth
  - Client
  - Extension
colombe.enhanced_status_codes
- Enhanced_status_codes
  - Client
    
    _
colombe.mime
- Mime
  - Client
colombe.mrmime
- Colombe_mrmime
colombe.starttls
- Starttls
  - Client
  - Extension

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module State : Sigs.FUNCTOR

module Protocol : PROTOCOL

Signature

type 's state = 's State.t

type event =

| Accept
| Recv : 'x Protocol.t * 'x -> event
| Send : 'x Protocol.t -> event
| Write of int
| Read of int
| Close

type action =

| Send : 'x Protocol.t * 'x -> action
| Recv : 'x Protocol.t -> action
| Write of {
1. buf : string;
2. off : int;
3. len : int;
}
| Read of {
1. buf : bytes;
2. off : int;
3. len : int;
}
| Close

type 's t

type 's transition =
  's state ->
  event ->
  (action * 's state, Protocol.error * 's state) result

val send : 'x Protocol.t -> 'x -> action

val recv : 'x Protocol.t -> action

val write : buf:string -> off:int -> len:int -> action

val read : buf:bytes -> off:int -> len:int -> action

val run : 's t -> ctx -> event -> ('s state, Protocol.error) process

val make : init:'s state -> 's transition -> 's t