emil
/
libircclient
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
LibIRCClient 1.10 Used by Probotic
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
4 Commits
1 Branch
507KB
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
libircclient/doc/sources/Introduction.rst

59 lines
2.9KB
Raw Permalink Blame History 

  1. =====================

  2. Introduction

  3. =====================

  4. 

  5. Overview

  6. ~~~~~~~~

  7. 

  8. Libircclient is a small but extremely powerful library which implements the client IRC protocol. It is designed to be small, fast, portable and compatible 

  9. with the RFC standards as well as non-standard but popular features. It is perfect for building the IRC clients and bots.

  10. 

  11. 

  12. Features

  13. ~~~~~~~~

  14.  - Comprehensive C API;

  15.  - Full coverage of the IRC protocol using providing functions;

  16.  - Supports multiple simultaneous connection to different IRC servers or even to the same server;

  17.  - Supports both plain and SSL connections to the IRC servers with the optional certificate check;

  18.  - Full multi-threading support, the library is thread-safe;

  19.  - All the processing could be handled by a single thread even if multiple connections are used;

  20.  - Non-blocking, asynchronous event-based interface implemented with callbacks;

  21.  - Extra support for the socket-based applications, which use select();

  22.  - CTCP support with optional build-in reply code;

  23.  - Supports CTCP PING necessary to pass the “spoof check” implemented by most IRC servers;

  24.  - Flexible DCC support, including both DCC chat, and DCC file transfer;

  25.  - Can both initiate and react to initiated DCC;

  26.  - Can accept or decline DCC sessions asynchronously;

  27.  - Written in plain C, very small binary size (around 30K depending on platform);

  28.  - Compatible all tested IRC clients;

  29.  - Free software licensed under the LGPLv3 license;

  30.  - Supports Linux as well as any POSIX-compliant Unix, Mac OS X and Microsoft Windows;

  31.  - Supports 32/64bit architectures as well as non-x86 architectures;

  32.  - IPv6 support (optional, must be compiled in);

  33.  - OpenSSL support (optional, must be compiled in);

  34.  - Cocoa interface by Nathan Ollerenshaw;

  35.  - Comprehensive documentation, examples and the FAQ;

  36. 

  37. 

  38. Known issues

  39. ~~~~~~~~~~~~

  40. 

  41. Even though possible by using multiple sessions, the library is not suitable to connect to a large number of IRC servers simultaneously. If you still want to use it, you'd have to overcome the following:

  42. 

  43.  - You cannot use the main loop in :c:func:`irc_run` because it only supports one session. You would have to use :c:func:`irc_add_select_descriptors`

  44.  - You'd have to handle reconnections separately by processing the relevant :c:func:`irc_process_select_descriptors` return values

  45.  - If you wish to use poll/epoll() instead of select() you'd have to write more logic as it is not directly supported. See the :ref:`FAQ <faq_epoll>`.

  46.  - The library is not optimized to have a low per-connection memory footprint, each non-SSL connection uses at least 4K, with around 32K per connection for SSL.

  47. 

  48. 

  49. Author

  50. ~~~~~~

  51. 

  52. This library is created by George Yunaev, copyright 2004-2016. Please see http://www.ulduzsoft.com/linux/libircclient

  53. 

  54. 

  55. License

  56. ~~~~~~~

  57. 

  58. Libircclient is licensed under Lesser General Public License version 3 or higher. The complete license text is provided in the Appendix.