package riot

You can search for identifiers within the package.

in-package search v0.2.0

riot
- Riot
  - Application
    
    Intf
  - Gen_server
    
    Impl
  - Logger
    
    Intf
    
    Make
    
    _
    
    Namespace
  - Message
  - Net
    
    Addr
    
    Socket
  - Pid
  - Process
    
    Messages
  - Queue
  - Ref
  - Supervisor
  - Telemetry
  - Timer
riot.core
- Core
  - Mailbox
  - Message
  - Pid
  - Proc_effect
  - Proc_queue
  - Proc_registry
    
    Exn
  - Proc_set
  - Proc_state
  - Proc_table
  - Process
    
    Messages
  - Ref
  - Scheduler_uid
riot.lib
- Lib
  - Application
    
    Intf
  - Gen_server
    
    Impl
  - Logger
    
    Formatter
  - Process
  - Supervisor
  - Telemetry
riot.lib.logger
- Logger
  - Intf
  - Level
  - Make
    
    _
  - Namespace
riot.lib.net
- Lib_net
  - Addr
  - Socket
riot.log
- Log
riot.net
- Net
  - Addr
  - Io
  - Socket
riot.runtime
- Runtime
  - Timer
riot.runtime.time
- Time
  - Timer_wheel
    
    Timer
riot.scheduler
- Scheduler
  - Pool
  - Tracer
riot.util
- Util
  - Dashmap
  - Fd
    
    Mode
  - Lf_queue
  - Thread_local
  - Uid

Legend:
Library
Module
Module type
Parameter
Class
Class type

type 'res req = ..

req is the type of all generic server requests and responses.

When defining a new generic server you want to extend this with the your custom request types, including the response type in its type variable. Like this:

```ocaml open Riot type _ Gen_server.req += | Is_connected : bool Gen_server.req | Profile : profile_req -> profile_res Gen_server.req ```

type 'state init_result =

| Ok of 'state
(*
use this value to enter the main loop with state 'state
*)
| Error
(*
use this value to crash the process and notify a supervisor of it
*)
| Ignore
(*
use this value to exit the process normally
*)

state init_result is used to initialize a new generic server.

module type Impl = sig ... end

Impl is the module type of the generic server base implementations. You can use this type when defining new gen servers like this:

type ('args, 'state) impl =
  (module Impl
  with type args = 'args
   and type state = 'state)

val call : Pid.t -> 'res req -> 'res

call pid req will send a type-safe request req to the generic server behind pid that is guaranteed to return a respone with type `'res`

This function will block the current process until a response arrives.

TODO(leostera): add ?timeout param

val start_link : ('args, 'state) impl -> 'args -> (Pid.t, exn) Stdlib.result

start_link (module S) args will spawn and link a new process that will act as a generic server over the server implementation of S, initialized with args arguments.