package calculon

  1. Overview
  2. Docs
On This Page
  1. Core IRC state

Module Calculon.CoreSource

Core IRC state

Sourcetype irc_msg = Irc_message.t
Sourcetype privmsg = {
  1. nick : string;
    (*

    author: nick

    *)
  2. to_ : string;
    (*

    target: nick or chan

    *)
  3. message : string;
    (*

    actual content

    *)
}

A message sent on some IRC channel, or in query. The message content is message, its sender is nick (a nickname), and its target is to_ (either a nickname for private messages, or a channel name).

Sourceval is_chan : string -> bool

Is this a valid chan name?

Sourceval reply_to : privmsg -> string

find whom to reply to. If the message is in query, that is, not (is_chan msg.to_), then reply to msg.nick; otherwise reply on the channel msg.to_.

Sourceval nick : privmsg -> string

The author of the message

Sourceval privmsg_of_msg : irc_msg -> privmsg option

Try to parse a privmsg from a raw IRC message

Sourceval string_of_privmsg : privmsg -> string
Sourcemodule type S = sig ... end
Sourcetype t = (module S)
Sourceval loop_ssl : ?conn_info:string -> connect:(unit -> Irc_client_lwt_ssl.connection_t option Lwt.t) -> init:(t -> unit Lwt.t) -> unit -> unit Lwt.t

Feed this to Lwt_main.run. It will connect using connect (which opens a TLS connection), create a new core object (of type t), call init on this core object (to initialize plugins, etc.) then loop on incoming messages. If the connection is closed for any reason, this will wait for some time and then re-connect and call init again, etc.

  • parameter conn_info

    how to display connection info in debug messages

Sourceval loop_unsafe : ?conn_info:string -> connect:(unit -> Irc_client_lwt.connection_t option Lwt.t) -> init:(t -> unit Lwt.t) -> unit -> unit Lwt.t

Feed to Lwt_main.run. Same as loop_tls but with a cleartext connection (boo!).

  • parameter conn_info

    how to display connection info in debug messages

Sourceval run : Config.t -> init:(t -> unit Lwt.t) -> unit -> unit Lwt.t

Main entry point: use config to pick the connection method, then call the appropriate auto-reconnection loop. Calls init every time a new connection is opened.

Logging

Sourceval logs_src : Logs.Src.t

Logs from Calculon should use this source.

  • since 0.6

Logger using logs_src.