1. Overview
  2. Docs
On This Page
  1. Plugins

Plugins

A plugin is a bunch of commands, and optionally some disk-backed state. It will register its commands to the core loop

type json = Yojson.Safe.json
type action =
  1. | Require_reload
    (*

    Require that we reload everything from on-disk state

    *)
  2. | Require_save
    (*

    Require that the state be saved

    *)
type action_callback = action Signal.Send_ref.t
type stateful =
  1. | St : 'st stateful_ -> stateful

A stateful plugin, using a persistent state 'st

and 'st stateful_ = private {
  1. name : string;
    (*

    Namespace for storing state. Must be distinct for every plugin.

    *)
  2. commands : 'st -> Command.t list;
    (*

    Commands parametrized by some (mutable) state, with the ability to trigger a signal

    *)
  3. on_msg : 'st -> (Core.t -> Irc_message.t -> unit Lwt.t) list;
    (*

    Executed on each incoming message

    *)
  4. to_json : 'st -> json option;
    (*

    How to serialize (part of) the state into JSON, if need be.

    *)
  5. of_json : action_callback -> json option -> ('st, string) Result.result Lwt.t;
    (*

    How to deserialize the state. None is passed for a fresh initialization.

    *)
  6. stop : 'st -> unit Lwt.t;
    (*

    Stop the plugin. It is NOT the responsibility of this command to save the state, as the core engine will have called to_json before.

    *)
}
type t =
  1. | Stateful of stateful
  2. | Stateless of Command.t list

A single plugin

type plugin = t
val of_cmd : Command.t -> t

Stateless plugin with 1 command.

val of_cmds : Command.t list -> t

Stateless plugin with several commands.

  • raises Invalid_argument

    if the list is empty

val stateful : name:string -> commands:('st -> Command.t list) -> ?on_msg:('st -> (Core.t -> Irc_message.t -> unit Lwt.t) list) -> to_json:('st -> json option) -> of_json:(action_callback -> json option -> ('st, string) Result.result Lwt.t) -> ?stop:('st -> unit Lwt.t) -> unit -> t

Make a stateful plugin using the given name (for prefixing its storage; this should be unique) and ways to serialize state to Json, deserialize state from Json, and building commands from the state. See stateful_ for more details on each field.

module Set : sig ... end