package irc-client

  1. Overview
  2. Docs
IRC client library - core functionality

Install

Dune Dependency

Authors

Maintainers

Sources

irc-client.0.7.0.tar.gz
sha256=8655fe6e074701f28f4539e3cfbf83c0bdb67f546435ca255234236a4d2be206

Description

Published: 01 Jul 2021

README

README.md

IRC client library, supporting Lwt and Unix blocking IO.

Build dependencies

The latest tagged version is available via opam: opam install irc-client

Usage

Simple bot which connects to a channel, sends a message, and then logs all messages in that channel to stdout:

open Lwt
module C = Irc_client_lwt

let host = "localhost"
let port = 6667
let realname = "Demo IRC bot"
let nick = "demoirc"
let username = nick
let channel = "#demo_irc"
let message = "Hello, world!  This is a test from ocaml-irc-client"

let callback _connection result =
  let open Irc_message in
  match result with
  | Result.Ok msg ->
    Lwt_io.printf "Got message: %s\n" (to_string msg)
  | Result.Error e ->
    Lwt_io.printl e

let lwt_main =
  Lwt_unix.gethostbyname host
  >>= fun he -> C.connect ~addr:(he.Lwt_unix.h_addr_list.(0))
                  ~port ~username ~mode:0 ~realname ~nick ()
  >>= fun connection -> Lwt_io.printl "Connected"
  >>= fun () -> C.send_join ~connection ~channel
  >>= fun () -> C.send_privmsg ~connection ~target:channel ~message
  >>= fun () -> C.listen ~connection ~callback ()
  >>= fun () -> C.send_quit ~connection

let _ = Lwt_main.run lwt_main

Compile the above with:

ocamlfind ocamlopt -package irc-client.lwt -linkpkg code.ml

Alternatively, you can find it at examples/example1.ml; enable its compilation with ./configure --enable-examples --enable-lwt.

Dependencies (6)

  1. ocaml
  2. base64 >= "3.1.0"
  3. logs >= "0.5.0"
  4. result
  5. base-bytes
  6. dune >= "1.6"

Dev Dependencies (2)

  1. odoc with-doc
  2. ounit with-test

Used by (5)

  1. calculon >= "0.7"
  2. irc-client-lwt = "0.7.0"
  3. irc-client-lwt-ssl = "0.7.0"
  4. irc-client-tls = "0.7.0"
  5. irc-client-unix = "0.7.0"

Conflicts

None