Calculon.Plugin.Set · calculon 0.6 · OCaml Packages

calculon

Library for writing IRC bots in OCaml and a collection of plugins

Version

Overview Documentation

IN THIS PACKAGE

library calculon
- module Calculon
  - module Command
  - module Config
  - module Core
    
    module type S
    
    module I
    
    module Io
  - module Lwt_err
  - module Plugin
    
    module Set
  - module Plugin_factoids
  - module Plugin_history
  - module Plugin_social
  - module Plugin_state
  - module Plugin_vote
  - module Prelude
    
    module Rand_distrib
    
    module StrMap
  - module Run_main
  - module Signal
    
    module Send_ref
  - module Talk

Module Calculon . Plugin . Set

Collection of Plugins

type t

val create : 
  ?cmd_help:bool ->
  Config.t ->
  plugin list ->
  ( t, string ) Result.result Lwt.t

Create a collection of plugins, loading the state, initializing them.

parameter cmd_help
if true, adds a "help" command.

val commands : t -> Command.t list

Corresponding list of commands

val on_msg_l : t -> ( Core.t -> Irc_message.t -> unit Lwt.t ) list

List of callbacks called on each message

val save : t -> unit Lwt.t

Save state to disk

val reload : t -> ( unit, string ) Result.result Lwt.t

Reload state from disk

val stop : ?save:bool -> t -> unit Lwt.t

Stop all plugins

parameter save
if true, will call save first (default true)