package irc-client

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

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (10)

Authors

  1. J
    John Else
  2. S
    Simon Cruanes

Maintainers

  1. J
    john.else@gmail.com

Sources

irc-client.0.6.1.tar.gz
sha256=4933418355cde3107bc39912ac4addf603adb6ea3c5c3119c41596848de9b6d0
md5=8de431994ea6c0a066ddd9e822d22f96

doc/irc-client/Irc_transport/module-type-IO/index.html

Module type Irc_transport.IOSource

Sourcetype 'a t
Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t
Sourceval return : 'a -> 'a t
Sourcetype file_descr

A connection to the remote IRC server

Sourcetype inet_addr

Remote addresses

Sourcetype config

Additional configuration, on a per-connection basis.

Sourceval open_socket : ?config:config -> inet_addr -> int -> file_descr t
Sourceval close_socket : file_descr -> unit t
Sourceval read : file_descr -> Bytes.t -> int -> int -> int t
Sourceval write : file_descr -> Bytes.t -> int -> int -> int t
Sourceval read_with_timeout : timeout:int -> file_descr -> Bytes.t -> int -> int -> int option t

read_with_timeout ~timeout fd buf off len returns Some n if it could read n bytes into buf (slice off,...,off+len-1), or None if nothing was read before timeout seconds.

Sourceval gethostbyname : string -> inet_addr list t

List of IPs that correspond to the given hostname (or an empty list if none is found)

Sourceval iter : ('a -> unit t) -> 'a list -> unit t
Sourceval catch : (unit -> 'a t) -> (exn -> 'a t) -> 'a t

Catch asynchronous exception

  • since NEXT_RELEASE
Sourceval sleep : int -> unit t
Sourceval time : unit -> float

Current wall time (used for timeouts). Typically, Unix.time.

  • since NEXT_RELEASE
Sourceval pick : ('a t list -> 'a t) option

OPTIONAL pick l returns the first thread of l that terminates (and might cancel the others)