package irc-client

  1. Overview
  2. Docs

Parameters

Signature

type connection_t

A connection to an IRC server.

val send_join : connection:connection_t -> channel:string -> unit Io.t

Send the JOIN command.

val send_nick : connection:connection_t -> nick:string -> unit Io.t

Send the NICK command.

val send_pass : connection:connection_t -> password:string -> unit Io.t

Send the PASS command.

val send_pong : connection:connection_t -> message:string -> unit Io.t

Send the PONG command.

val send_privmsg : connection:connection_t -> target:string -> message:string -> unit Io.t

Send the PRIVMSG command.

val send_notice : connection:connection_t -> target:string -> message:string -> unit Io.t

Send the NOTICE command.

val send_quit : connection:connection_t -> unit Io.t

Send the QUIT command.

val send_user : connection:connection_t -> username:string -> mode:int -> realname:string -> unit Io.t

Send the USER command.

val connect : addr:Io.inet_addr -> port:int -> username:string -> mode:int -> realname:string -> nick:string -> ?password:string -> unit -> connection_t Io.t

Connect to an IRC server at address addr. The PASS command will be sent if password is not None.

val connect_by_name : server:string -> port:int -> username:string -> mode:int -> realname:string -> nick:string -> ?password:string -> unit -> connection_t option Io.t

Try to resolve the server name using DNS, otherwise behaves like connect. Returns None if no IP could be found for the given name.

val listen : connection:connection_t -> callback: (connection:connection_t -> result:Irc_message.parse_result -> unit Io.t) -> unit Io.t

listen connection callback listens for incoming messages on connection. All server pings are handled internally; all other messages are passed, along with connection, to callback.

OCaml

Innovation. Community. Security.