libircclient man page

libircclient — Libircclient Documentation

Introduction

Introduction

Overview

Libircclient is a small but extremely powerful library which implements the client IRC protocol. It is designed to be small, fast, portable and compatible with the RFC standards as well as non-standard but popular features. It is perfect for building the IRC clients and bots.

Features

·
Comprehensive C API;
·
Full coverage of the IRC protocol using providing functions;
·
Supports multiple simultaneous connection to different IRC servers or even to the same server;
·
Supports both plain and SSL connections to the IRC servers with the optional certificate check;
·
Full multi-threading support, the library is thread-safe;
·
All the processing could be handled by a single thread even if multiple connections are used;
·
Non-blocking, asynchronous event-based interface implemented with callbacks;
·
Extra support for the socket-based applications, which use select();
·
CTCP support with optional build-in reply code;
·
Supports CTCP PING necessary to pass the “spoof check” implemented by most IRC servers;
·
Flexible DCC support, including both DCC chat, and DCC file transfer;
·
Can both initiate and react to initiated DCC;
·
Can accept or decline DCC sessions asynchronously;
·
Written in plain C, very small binary size (around 30K depending on platform);
·
Compatible all tested IRC clients;
·
Free software licensed under the LGPLv3 license;
·
Supports Linux as well as any POSIX-compliant Unix, Mac OS X and Microsoft Windows;
·
Supports 32/64bit architectures as well as non-x86 architectures;
·
IPv6 support (optional, must be compiled in);
·
OpenSSL support (optional, must be compiled in);
·
Cocoa interface by Nathan Ollerenshaw;
·
Comprehensive documentation, examples and the FAQ;

Known issues

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:

·
You cannot use the main loop in irc_run() because it only supports one session. You would have to use irc_add_select_descriptors()
·
You'd have to handle reconnections separately by processing the relevant irc_process_select_descriptors() return values
·
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 FAQ.
·
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.

Author

This library is created by George Yunaev, copyright 2004-2013.

License

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

Integration

Integration

Requirements

Supported operating systems and compilers

The library has been extensively tested on Linux x86 and x86_64. It has also been tested on Solaris x86, Linux on ARM and Linux on MIPS platforms, on Mac OS X on x86 and on various versions of Microsoft Windows.

Compilation

On Linux, FreeBSD and Mac OS X the library has to be compiled and installed before use unless you use a precompiled package provided by your operating system distribution. If it is provided, you are recommended to use it as it would be updated from the central repository when the bugs are fixed.

On Microsoft Windows the official library binaries are provided, so you do not have to build it. Unless you have experience building with Cygwin, you're advised not to build from source and use the official binary.

Required libraries

The library depends only on libc (glibc-devel on Linux) and gcc, although the examples require also libstdc++ (libstdc++-devel) and g++. Minimum supported version is glibc 2.2, although if IPv6 is requested, at least glibc 2.4 is required.

If the library is built with SSL support, the openssl development package (openssl-devel) needs to be installed.

On Microsoft Windows the Cygwin with necessary development packages must be installed (and openssl-devel as well).

Compiling

The library is configured and built the standard Unix way:

./configure [--enable-openssl] [--enable-ipv6]
make

Installing

Although no install is necessary to use the libraries, the install target is provided for convenience and could be invoked via sudo make install

Linking

Link your application with either libircclient.a or libircclient.so depending on your needs. If you use the system-provided library, please link with libircclient.so.

If you have built the library with SSL support, you will need to link with OpenSSL libraries; add -lcrypto -lssl to your LDFLAGS

On Microsoft Windows please link with libircclient.lib which implicitly links with libircclient.dll

Coding

Initialization

Include the headers

Before using the library you need to include the library header libircclient.h. You may also want to include libirc_rfcnumeric.h which provides the RFC codes:

#include "libircclient.h"
#include "libirc_rfcnumeric.h"

Create event handlers

Unlike most network protocols such as HTTP or SMTP, the IRC protocol is event-based. The events come from server asynchronously. Some events are triggered by your action (such as joining the channel or changing your nick), some are triggered by other IRC users (such as sending you a message), and some are triggered by the IRC server itself (such as sending operation notes or invoking NickServ services).

Libircclient helps handling those events by providing the event handling structure. It declares the events you can define in your application, and when such event is received from the server, the appropriate callback will be called. The number of events you need to handle depending on the complexity of your client and the functionality it supports.

Generally there are only two events you must handle to provide a bare minimum functionality: event_connect and event_numeric. However it is recommended to create an event dump function and use it for all unused events to make sure you do not miss an important event because you expected a wrong one. See function dump_event in the file examples/irctest.c

Windows-specific initialization

If you link with the static library on Microsoft Windows, you need to initialize the Winsock2 library before calling the library functions. It could be done by following:

WSADATA wsaData;

if ( WSAStartup ( MAKEWORD (2, 2), &wsaData) != 0 )
    // report an error

However if you link with the dynamic library (libircclient.dll) which is default if you use the official build, this is not needed because the DLL initializes it automatically on load.

Create an IRC session

To use the library at least one IRC session needs to be created. One session could be used to establish a single connection to one IRC server for one nick. However more than one session could be created if needed.

To create a session, call the irc_create_session() function:

// The IRC callbacks structure
irc_callbacks_t callbacks;

// Init it
memset ( &callbacks, 0, sizeof(callbacks) );

// Set up the mandatory events
callbacks.event_connect = event_connect;
callbacks.event_numeric = event_numeric;

// Set up the rest of events

// Now create the session
irc_session_t * session = irc_create_session( &callbacks );

if ( !session )
    // Handle the error

This code could be repeated as many times as needed to create multiple sessions. The same callback structure could be reused for multiple sessions.

Set options

Besides debugging there are two options you may need to use. The LIBIRC_OPTION_STRIPNICKS enables automatic parsing of nicknames, and since it is hard to imagine the case when it should not be enabled, we enable it:

irc_option_set( session, LIBIRC_OPTION_STRIPNICKS );

The second option you may need if you use SSL connections and plan to connect to the servers which use self-signed certificates. See the documentation for LIBIRC_OPTION_SSL_NO_VERIFY

Connect to the server

To initiate the connection to the IRC server, call the irc_connect() function:

// Connect to a regular IRC server
if ( irc_connect (session, "irc.example.com", 6667, 0, "mynick", "myusername", "myrealname" ) )
  // Handle the error: irc_strerror() and irc_errno()

To initiate the connection to the IRC server over SSL, call the irc_connect() function and prefix the host name or IP address with a hash symbol:

// Connect to the SSL server; #192.168.1.1 is also possible
if ( irc_connect (session, "#irc.example.com", 6669, 0, "mynick", "myusername", "myrealname" ) )
  // Handle the error: irc_strerror() and irc_errno()

This function only initiates the connection, so when it successfully returns the connection is only initiated, but not established yet. Then one of the following happens after you invoke the networking handler:

·
If the connection is established, you will receive the event_connect - this is why it is important to handle it
·
If the connection failed, the networking handler function will return failure

Connect to the IPv6 server

To initiate the connection to the IPv6 server, call the irc_connect6() function:

if ( irc_connect6 (session, "2001:0db8:85a3:0042:1000:8a2e:0370:7334", 6669, 0, "mynick", "myusername", "myrealname" ) )
  // Handle the error: irc_strerror() and irc_errno()

The rest of the details, including the return value and the SSL are the same as with regular connect.

Start the networking loop

To let the library handle the events, there are two scenarios. You can either invoke the built-in networking loop which will handle the networking and call your events, or you can write your own loop.

Invoking the build-in networking loop is simpler but limited. Since it loops until the connection terminates, it is not an option for a GUI application (unless you start the loop in a separate thread which you can do). And since this loop only can handle one session, it is impossible to use it if you want to handle multiple IRC sessions. In those cases the custom networking loop, described below, should be used.

To start the event loop call the irc_run() function:

if ( irc_run (s) )
  // Either the connection to the server could not be established or terminated. See irc_errno()

Remember that irc_run() call will not return until the server connection is not active anymore.

Use the custom networking loop

If you use multiple sessions or have your own socket handler, you can use the custom networking loop. In this case your application must be select()-based (see the FAQ if you want to use other polling methods). And you need to run the following loop:

// Make sure that all the IRC sessions are connected
if ( !irc_is_connected(session) )
  // reconnect it, or abort

// Create the structures for select()
struct timeval tv;
fd_set in_set, out_set;
int maxfd = 0;

// Wait 0.25 sec for the events - you can wait longer if you want to, but the library has internal timeouts
// so it needs to be called periodically even if there are no network events
tv.tv_usec = 250000;
tv.tv_sec = 0;

// Initialize the sets
FD_ZERO (&in_set);
FD_ZERO (&out_set);

// Add your own descriptors you need to wait for, if any
...

// Add the IRC session descriptors - call irc_add_select_descriptors() for each active session
irc_add_select_descriptors( session, &in_set, &out_set, &maxfd );

// Call select()
if ( select (maxfd + 1, &in_set, &out_set, 0, &tv) < 0 )
   // Error

// You may also check if any descriptor is active, but again the library needs to handle internal timeouts,
// so you need to call irc_process_select_descriptors() for each session at least once in a few seconds
...

// Call irc_process_select_descriptors() for each session with the descriptor set
if ( irc_process_select_descriptors (session, &in_set, &out_set) )
    // The connection failed, or the server disconnected. Handle it.

// Do it again

Channels and users

Before calling any of those functions make sure you have connected to the server.

Join and leave a channel

To join the channel call the irc_cmd_join() function with the channel name:

// Join the channel #linux
if ( irc_cmd_join( session, "#linux", 0 ) )
  // most likely connection error

// Join the channel $science protected by the secret key *superpassword*
if ( irc_cmd_join( session, "$science", "superpassword" ) )
  // most likely connection error

You can join as many channels as you want, although the serer may restrict the number of channels you can join simultaneously.

If the join was successful you will receive the event_join event. You need to wait for this event before you can perform any channel operations (such as sending the messages). However you do NOT have to wait for this event to issue a second JOIN command as shown in the example above.

If the join was not successful, you will receive the error via event_numeric.

To leave the channel call the irc_cmd_part() function with the channel name:

// Leave the channel #linux
if ( irc_cmd_part( session, "#linux" ) )
  // most likely connection error

// Leave the channel $science
if ( irc_cmd_part( session, "$science" ) )
  // most likely connection error

Send a message to a channel or to a user

After you have joined the channel, you can send a message to the channel by using the irc_cmd_msg() function with the channel name:

// Say "Hi!" to everyone in the channel #linux
if ( irc_cmd_msg( session, "#linux", "Hi!" ) )
  // most likely connection error

Technically the protocol does not require one to join the channel to send the messages into the channel. However most servers by default set the channel mode which prevents the users who did not join the channel from sending the message into the channel.

Same function is used to send a "private" message to another user. The "private" messages do not go through the channels, but they still go through the IRC server (sometime multiple servers) and can be seen or even logged by the IRC network operators.

// Say "Hi!" to IRC user john
if ( irc_cmd_msg( session, "john", "Hi!" ) )
  // most likely connection error

If the message was sent successfully you will not receive any confirmation or event. You will only receive the error via event_numeric if the message was not sent.

Receive messages from a channel or from a user

You receive the channel messages by handling the event_channel. Each time someone says something in the channel this event is called.

You receive the "private" messages from other users by handling the event_privmsg.

Those event handlers should be created in your application and passed to the library when you create an IRC session

Send an action message

"Action" messages, also called /me messages, are specially formatted CTCP messages. However the library contains a special function to send them, irc_cmd_me(). Actions sent by other people are handled by the event_ctcp_action event.

Same as with sending messages no confirmation is received on success.

Send a CTCP request

Other CTCP requests such as PING, VERSION etc should be sent by calling irc_cmd_ctcp_request(). If the CTCP response is received, it is handled by the event_ctcp_rep event.

Handling DCC chat

Implementing the DCC callback

No matter whether you plan to initiate DCC chats or respond to them you must implement the DCC callback:

void dcc_callback (irc_session_t * session, irc_dcc_t id, int status, void * ctx, const char * data, unsigned int length)
{
   if ( status )
   {
       // If status is LIBIRC_ERR_CLOSED, the chat has been closed by the remote party.
       // Otherwise it is an error; the CHAT either terminated or could not be established. status is the error code; see irc_strerror(status)
   }
   else if ( length == 0 )
   {
       // The remote side has accepted the chat request, send "hello" something to them
       irc_dcc_text( session, id, "Hello!" );
   }
   else
   {
       // We have received the chat message from the remote party
       printf ("Remote party said: %s\n", data );
   }
}

This callback should be passed to either irc_dcc_chat() function which initiates the request, or to irc_dcc_accept() function which accepts the DCC CHAT request initiated by another user.

Initiating the DCC CHAT

You can initiate the DCC chat with another user by calling irc_dcc_chat():

// The DCC chat session id will be returned in this variable
irc_dcc_t dccid;

// Initiate the DCC chat with the IRC user "john"
if ( irc_dcc_chat( session, 0, "john", dcc_callback, &dccid ) )
  // report error

Now you can proceed with other tasks. When John accepts or declines the chat, the dcc_callback() will be called, and it will be possible to use the irc_dcc_text() function to send the chat messages. The callback will also be called each time a new chat message is received, or when the chat is finished or terminated because of network error.

Responding to DCC CHAT requests

To respond to the DCC CHAT equests your application should implement for the event_dcc_chat_req event. The callback could be implemented as following:

void callback_event_dcc_chat( irc_session_t * session, const char * nick, const char * addr, irc_dcc_t dccid )
{
    // User 'nick' from the IP address 'addr' tries to initiate the DCC chat with us.
    // Store this information in the application internal queue together with the dccid so the callback can return
    dcc_queue.store( dccid, "CHAT from " + nick + " IP address: " + addr  );
}

and registered when the IRC session is created. If your application does not handle DCC at all you can just call the irc_dcc_decline() function inside the callback.

If it does, we only store this information in the callback, and return. This is because the event processing will stop until the callback returns, so popping up the dialog asking for the user confirmation would stop further events such as channel messages from being processed. Even if your application is automatic and doesn't pop up dialogs it is still better to separate the chat logic from the callback logic.

Somewhere later the application would check the queue in the GUI thread, get this information, and pop up the dialog asking the user feedback. Then if the chat request was accepted, the application would call the irc_dcc_accept() function, and if it was declined, the application would call the irc_dcc_decline() function. Both functions will accept the dccid which identifies this specific request:

// Somewhere in the GUI thread
if ( !dcc_queue.empty() )
{
    // Get the DCC information and show the dialog to the user
    irc_dcc_t dccid = dcc_chat_queue.top().dccid;

    ...

    // React to the user entry
    if ( dialog.isAccepted() )
        irc_dcc_accept( session, dccid, 0, dcc_callback );
    else
        irc_dcc_decline( session, dccid );
}

Send CHAT messages

Once the chat session is established, you can send the chat messages using irc_dcc_text() function. Note that you need to pass the dcc session id instead of nick:

irc_dcc_text( session, dccid, "Hello there!" );

Handling DCC file transfer

This section covers handling sending and receiving files via DCC.

Implementing the callback

No matter whether you plan to send or receive files via dcc you must implement the DCC callback. While the same callback may be used both for sending and receiving, this is not recommended since the logic is different. Therefore the suggested implementation would be to use different callbacks as suggested:

// This callback is used when we send a file to the remote party
void callback_dcc_send_file (irc_session_t * session, irc_dcc_t id, int status, void * ctx, const char * data, unsigned int length)
{
   if ( status )
   {
       // It is an error; the send operation was either terminated or the connection could not be established. status is the error code; see irc_strerror(status)
   }
   else
   {
       // We have sent some data to the remote party, 'length' indicates how much data was sent
       printf ("Sent bytes: %d\n", length );
   }
}

// This callback is used when we receive a file from the remote party
void callback_dcc_recv_file (irc_session_t * session, irc_dcc_t id, int status, void * ctx, const char * data, unsigned int length)
{
   if ( status )
   {
       // It is an error; the send operation was either terminated or the connection could not be established. status is the error code; see irc_strerror(status)
   }
   else if ( data == 0 )
   {
       // File transfer has been finished
       printf ("File has been received successfully\n" );
   }
   else
   {
       // More file content has been received. Store it in memory, write to disk or something
       printf ("Received %d bytes of data\n", length );
   }
}

This callback should be passed to either irc_dcc_sendfile() function which initiates the request, or to irc_dcc_accept() function which accepts the DCC RECVFILE request initiated by another user.

Sending the file via DCC

You can initiate sending the file via DCC to another user by calling irc_dcc_sendfile():

// The DCC session id will be returned in this variable
irc_dcc_t dccid;

// Initiate sending of file "/etc/passwd" via DCC chat to the IRC user "john"
if ( irc_dcc_sendfile( session, 0, "john", "/etc/passwd", callback_dcc_send_file, &dccid ) )
  // report error

Now you can proceed with other tasks. When John accepts the request, the file will be sent and callback_dcc_send_file() will be called each time a piece of file is sent. The callback will also be called when the file has been sent, or when sending was terminated because of network error.

Receive a file via DCC

To receive the file via DCC a remote user must initiate the DCC request to send you a file. To receive this request your application should implement the event_dcc_send_req event. The callback could be implemented as following:

void callback_event_dcc_file( irc_session_t * session, const char * nick, const char * addr, const char * filename, unsigned long size, irc_dcc_t dccid )
{
    // User 'nick' from the IP address 'addr' tries to initiate the DCC chat with us.
    // Store this information in the application internal queue together with the dccid so the callback can return
    dcc_queue.store( dccid, "CHAT from " + nick + " IP address: " + addr + ", filename " + filename  );
}

If your application does not handle DCC at all you can just call the irc_dcc_decline() function inside the callback.

If it does, we only store this information in the callback, and return. This is because the event processing will stop until the callback returns, so popping up the dialog asking for the user confirmation would stop further events such as channel messages from being processed. Even if your application is automatic and doesn't pop up dialogs it is still better to separate the chat logic from the callback logic.

Somewhere later the application would check the queue in the GUI thread, get this information, and pop up the dialog asking the user feedback. Then if the chat request was accepted, the application would call the irc_dcc_accept() function, and if it was declined, the application would call the irc_dcc_decline() function. Both functions will accept the dccid which identifies this specific request:

// Somewhere in the GUI thread
if ( !dcc_queue.empty() )
{
    // Get the DCC information and show the dialog to the user
    irc_dcc_t dccid = dcc_chat_queue.top().dccid;

    ...

    // React to the user entry
    if ( dialog.isAccepted() )
        irc_dcc_accept( session, dccid, 0, dcc_callback );
    else
        irc_dcc_decline( session, dccid );
}

Note that it is not possible to request a remote user to send you a file.

Handling colors

Stripping colors from the message

If your bot reacts on the text messages, you need to strip down the colors from the text messages before processing them. Otherwise the user sending the colored message won't get the same reaction as the user who doesn't use colors, and some users use colors by default.

Use the irc_color_strip_from_mirc() function to strip the ANSI colors from the text message. It does not modify the message which doesn't use colors.

Color conversion

The library supports color translation, and can convert colors between the ANSI colors used by the IRC clients and their textual representation. Colors usage is typically limited to the messages and user specified reasons. You cannot use colors as part of your nick or channel name.

Use the irc_color_convert_from_mirc() function to convert colors from ANSI to the library textual representation, and irc_color_convert_to_mirc() to convert the library textual representation of colors into ANSI.

Do not forget to free() the returned pointer once it is not used anymore.

Miscellaneous

Tracking user nicks

If your application maintains some user-specific quotas, it is important to track the nick changes. Since the nick is the only identifier available to you, each time the user changes the nick you need to update your quota database. To do so you need to intercept the event_nick event. See the examples/censor.c for details.

API Reference

Callbacks

This section describes the callbacks supported by the library.

irc_event_callback_t

Prototype:

typedef void (*irc_event_callback_t)(irc_session_t * session, const char * event, const char * origin, const char ** params, unsigned int count)

Parameters:

sessionThe IRC session, which generated the event
eventThe text name of the event. Useful in case a single event handler is used to handle multiple events
originThe originator of the event. Depends on the event.
paramsExtra parameters, if any, for this event. The number of extra parameters depends on the event, and may be zero. Each parameter is a NULL-terminated text string. None of the params can be NULL, but the params pointer itself could be NULL for some events.
countThe number of entries in the params argument supplied.

Description:

Every IRC event generates a callback. This type of callback is universal and is used by almost all IRC events. Depending on the event nature, it can have zero or more parameters. For each type of event, the number of provided parameters is fixed, and their meaning is described in the irc_callbacks_t structure.

Every event has an origin (i.e. who originated the event). In some cases the origin variable may be NULL, which indicates that event origin is unknown. The origin usually looks like nick!host@ircserver, i.e. like tim!home@irc.server.net. Such origins can not be used in IRC commands, and need to be stripped (i.e. host and server part should be cut off) before using. This can be done either manually, by calling irc_target_get_nick(), or automatically for all the events - by setting the LIBIRC_OPTION_STRIPNICKS option with irc_option_set().

irc_event_dcc_chat_t

Prototype:

typedef void (*irc_event_dcc_chat_t)(irc_session_t * session, const char * nick, const char * addr, irc_dcc_t dccid)

Parameters:

sessionIRC session, which generates an event (the one returned by irc_create_session)
nickUser who requested the chat
addrIP address of the person such as 189.12.34.56
dccidIdentifier associated with this request which should be passed to the irc_dcc_accept() / irc_dcc_decline() functions

Description:

This callback is called when someone requests DCC CHAT with you. DCC CHAT is the type of chat which goes directly between the clients, instead of going through the IRC server. Since the TCP connection must be established for it to happen, typically the initiator must either have the public IP or special software on the firewall which handles the necessary port forwarding.

You must respond to the chat request either by calling irc_dcc_accept() to accept it, or by calling irc_dcc_decline() to decline it.

irc_event_dcc_send_t

Prototype:

typedef void (*irc_event_dcc_send_t)(irc_session_t * session, const char * nick, const char * addr, const char * filename, unsigned long size, irc_dcc_t dccid)

Parameters:

sessionThe IRC session, which generates an event (the one returned by irc_create_session)
nickThe user who requested the chat
addrThe IP address of the person such as 189.12.34.56
filenameThe name of the file the user is trying to send you
sizeThe size of the file
dccidIdentifier associated with this request which should be passed to the irc_dcc_accept() / irc_dcc_decline() functions

Description:

This callback is called when someone wants to send you a file by using DCC SEND. DCC SEND goes directly between the clients, and requires the TCP connection to be established established for it to happen. Therefore the initiator must either have the public IP or special software on the firewall which handles the necessary port forwarding.

You must respond to the chat request either by calling irc_dcc_accept() to accept it, or by calling irc_dcc_decline() to decline it.

irc_dcc_callback_t

Prototype:

typedef void (*irc_dcc_callback_t)(irc_session_t * session, irc_dcc_t id, int status, void * ctx, const char * data, unsigned int length)

Parameters:

sessionThe IRC session, which generates an event (the one returned by irc_create_session)
idThe DCC session id
statusThe DCC connection status. 0 means there is no error, otherwise contains an error code
ctxThe user-provided context
dataData received (if available), otherwise NULL
lengthSize of the data received if any data

Description:

This callback is called for all DCC functions when state change occurs.

For DCC CHAT, the callback is called as following:
·
status is LIBIRC_ERR_CLOSED: connection is closed by remote peer. After returning from the callback, the DCC session is automatically destroyed
·
status is nonzero but not LIBIRC_ERR_CLOSED: socket I/O error (connect error, accept error, recv error, send error). After returning from the callback, the DCC session is automatically destroyed
·
status is zero and length is zero: the remote side accepted the chat request
·
status is zero and length is nonzero: new chat message received, data contains the message (a null-terminated string), length contains the string length without null terminator
For DCC SEND, while file is being sent, the callback is called as following:
·
status is nonzero: socket I/O error (connect error, accept error, recv error, send error). After returning from the callback, the DCC session is automatically destroyed
·
status is zero: another data packet has been sent, length contains the total amount of data sent so far, data is NULL
For DCC RECV, while file is being sending, callback called as following:
·
status is nonzero: socket I/O error (connect error, accept error, recv error, send error). After returning from the callback, the DCC session is automatically destroyed.
·
status is zero, and data is NULL: the file has been received successfully. After returning from the callback, the DCC session is automatically destroyed.
·
status is zero, and data is not NULL: new data received, data contains the data received, length contains the amount of data received.

irc_eventcode_callback_t

Prototype:

typedef void (*irc_eventcode_callback_t)(irc_session_t * session, unsigned int event, const char * origin, const char ** params, unsigned int count)

Parameters:

sessionThe IRC session, which generates an event (the one returned by irc_create_session)
eventThe numeric code of the event. Useful in case a single event handler is used to handle multiple events
originThe originator of the event. Depends on the event.
paramsExtra parameters, if any, for this event. The number of extra parameters depends on the event, and may be zero. Each parameter is a NULL-terminated text string. None of the params can be NULL, but the params pointer itself could be NULL for some events.
countThe number of entries in the params argument supplied.

Description:

This is an advanced callback for those who want to handle events deeper. Most times the IRC server replies to your actions with numeric events. Most of those events are error codes, and some are list-start and list-stop markers. Every code has its own set of params; for details you can either experiment, or read RFC 1459 (don't expect servers to follow it closely though).

Every event has an origin (i.e. who originated the event). In some cases the origin variable may be NULL, which indicates that event origin is unknown. The origin usually looks like nick!host@ircserver, i.e. like tim!home@irc.server.net. Such origins can not be used in IRC commands, and need to be stripped (i.e. host and server part should be cut off) before using. This can be done either manually, by calling irc_target_get_nick(), or automatically for all the events - by setting the LIBIRC_OPTION_STRIPNICKS option with irc_option_set().

Functions

This section describes the functions defined in the library which are grouped by the purpose.

Library initialization and shutdown

irc_create_session

Prototype:

irc_session_t * irc_create_session(irc_callbacks_t * callbacks)

Parameters:

callbacks | Event callbacks structure, which defines several callbacks, which will be called on appropriate events. Cannot be NULL.

Description:

Creates and initiates a new IRC session. Every session represents a single user connection to a single IRC server, and possibly to one or more users via DCC. Almost every library function requires this object to be passed to, and therefore this function should be called first. Multiple sessions could be allocated to support multiple connections.

When it is not needed anymore, the session must be destroyed by calling the irc_destroy_session() function.

Return value:

An irc_session_t object, or 0 if creation failed. Usually, failure is caused by out of memory error.

Thread safety:

This function can be called simultaneously from multiple threads. Same callback structure may be reused by multiple threads.

irc_destroy_session

Prototype:

void irc_destroy_session(irc_session_t * session)

Parameters:

session | The IRC session handle

Description:

This function destroys an IRC session, closes the connection to the IRC server, and frees all the used resources. After calling this function you should not use this session object anymore.

Thread safety:

This function can be called simultaneously from multiple threads.

Connecting, disconnecting and running the main event loop

irc_connect6

Prototype:

int irc_connect6(irc_session_t * session, const char * server, unsigned short port, const char * password, const char * nick, const char * username, const char * realname)

irc_connect

Prototype:

int irc_connect(irc_session_t * session, const char * server, unsigned short port, const char * password, const char * nick, const char * username, const char * realname)

Parameters:

sessionIRC session handle
serverIP address or the host name of the server. If prefixed with #, the library will try to establish the SSL connection IPv4 address should be in numeric form such as 154.23.112.33; IPv6 address should be in IPv6 form
portPort number to connect to, usually 6667
passwordIRC server password, if the server requires it. May be NULL, in this case password will not be send to the IRC server. Vast majority of IRC servers do not require passwords. This is NOT NickServ/ChanServ password
nickNick which will be used to log into the IRC server. Cannot be NULL
usernameUsername of the Unix account which is used to connect to the IRC server. This is for information only, will be shown in "user properties" dialogs and returned by /whois request. Can be NULL in which case "nobody" would be used
realnameA real name of the person, who connects to the IRC. In reality nobody uses this field for that. Instead this field is used as user self-description, advertising, or other purposes. This information also will be shown in "user properties" dialogs and returned by /whois request. May be NULL, in this case "noname" will be used

Description:

This function initiates the connection to the IPv4 (irc_connect) or IPv6 (irc_connect6) IRC server. The server could be specified either by an IP address or by the DNS name. The irc_connect6 works only if the library was built with the IPv6 support.

If the library was built with the OpenSSL support, and the IP address or the host name is prefixed by a hash, such as "#irc.example.com", the library attempts to establish the SSL connection.

The connection is established asynchronously, and the event_connect is called once the connection is established.

A single IRC session object can only be connected to a single IRC server and only with a single nick, meaning it is not possible to have multiple nicks sharing a single connection.

Return value:

Returns 0 if the connection is initiated successfully. This doesn't mean the connection is established - the event_connect is called when it happens. If the connection cannot be established, either irc_run() or irc_process_select_descriptors() will return an error.

Thread safety:

This function can be called simultaneously from multiple threads, but not using the same session object.

irc_disconnect

Prototype:

void irc_disconnect(irc_session_t * session)

Parameters:

session | IRC session handle

Description:

This function closes the IRC connection. After that connection is closed, if the libirc was looped in the irc_run() loop, it automatically leaves the loop and irc_run() returns.

Thread safety:

This function can be called simultaneously from multiple threads, but not using the same session object.

irc_is_connected

Prototype:

int irc_is_connected(irc_session_t * session)

Parameters:

sessionIRC session handle

Return value:

This function returns 1 if the connection to the IRC server is established or 0 if it is not.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_run

Prototype:

int irc_run(irc_session_t * session)

Parameters:

sessionIRC session handle

Description:

This function enters into forever loop, processing the IRC events, and calling the relevant callbacks. This function will not return until the server connection is terminated - either by server, or by calling irc_cmd_quit. This function should only be used if you use a single IRC session and don't need asynchronous request processing (i.e. your bot just reacts on the events, and doesn't generate it asynchronously). Even in last case, you still can call this function and start the asynchronous thread in event_connect handler. See the examples.

Return value:

This function returns a nonzero value if the connection to the IRC server could not be established, or was terminated.

Thread safety:

This function cannot be called from multiple threads. Use irc_add_select_descriptors() and irc_process_select_descriptors() instead.

irc_add_select_descriptors

Prototype:

int irc_add_select_descriptors(irc_session_t * session, fd_set *in_set, fd_set *out_set, int * maxfd)

Parameters:

sessionIRC session handle
in_setfd_set input descriptor set for select()
out_setfd_set output descriptor set for select()
maxfdLargest descriptor already in all the sets. Will be updated if libirc adds larger number to the FD_SET array

Description:

This function should be used after you called irc_connect(). It is useful when you have your own select-based event processing loop. To use it you should put your own descriptors into the sets, call this function to add the library descriptor(s) into the set, and then call select(). When it returns, you should call irc_process_select_descriptors() which will handle the events and calls your callbacks(!). Then you can process your sockets events from set. See the example.

What if you use epoll? See the FAQ

Return value:

This function returns a nonzero value if the irc_connect() was not called before calling this function.

Thread safety:

This function can be called simultaneously from multiple threads, but it rarely makes sense.

irc_process_select_descriptors

Prototype:

int irc_process_select_descriptors(irc_session_t * session, fd_set *in_set, fd_set *out_set)

Parameters:

sessionIRC session handle
in_setfd_set input descriptor set for select()
out_setfd_set output descriptor set for select()

Description:

This function should be used in pair with irc_add_select_descriptors() function, which documentation describes how they work together.

Note that while processing the events this function calls your callbacks and it will not return until all your callbacks return. Keep that in mind if you pop up a dialog in your application, such as a DCC CHAT or DCC SEND confirmation dialog.

Return value:

Return code 0 means success. Other value means error, the error code may be obtained through irc_errno().

Thread safety:

This function can be called simultaneously from multiple threads for different IRC session objects only.

Managing the IRC channels: joining, leaving, inviting

irc_cmd_join

Prototype:

int irc_cmd_join(irc_session_t * session, const char * channel, const char * key)

Parameters:

sessionIRC session handle
channelChannel name to join. Cannot be NULL.
keySecret key for the channel. Can be NULL if not needed

Description:

Use this function to join the new IRC channel. If the channel does not exist, it will be automatically created by the IRC server. Note that to JOIN the password-protected channel, you must know the password, and specify it in the key argument. If join is successful, the event_join will be called (with your nick as the origin), then typically the event_topic is be called and then you receive the list of users who are on the channel (by using LIBIRC_RFC_RPL_NAMREPLY), which will include the user who just joined.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_BANNEDFROMCHAN
·
LIBIRC_RFC_ERR_INVITEONLYCHAN
·
LIBIRC_RFC_ERR_BADCHANNELKEY
·
LIBIRC_RFC_ERR_CHANNELISFULL
·
LIBIRC_RFC_ERR_BADCHANMASK
·
LIBIRC_RFC_ERR_NOSUCHCHANNEL
·
LIBIRC_RFC_ERR_TOOMANYCHANNELS

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_part

Prototype:

int irc_cmd_part(irc_session_t * session, const char * channel)

Parameters:

sessionIRC session handle
channelChannel name to leave. Cannot be NULL.

Description:

Use this function to leave the IRC channel you've already joined to. An attempt to leave the channel you aren't in results a LIBIRC_RFC_ERR_NOTONCHANNEL server error.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NOSUCHCHANNEL
·
LIBIRC_RFC_ERR_NOTONCHANNEL

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_invite

Prototype:

int irc_cmd_invite(irc_session_t * session, const char * nick, const char * channel)

Parameters:

sessionIRC session handle
nickNick name of the user to invite
channelChannel name to join. Cannot be NULL

Description:

This function is used to invite someone to invite-only channel. "Invite-only" is a channel mode, which restricts anyone, except invided, to join this channel. After invitation, the user could join this channel. The user, who is invited, will receive the event_invite event. Note that you must be a channel operator to invite the users.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

On success one of the following replies returned:
·
LIBIRC_RFC_RPL_INVITING
·
LIBIRC_RFC_RPL_AWAY
Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NEEDMOREPARAMS
·
LIBIRC_RFC_ERR_NOSUCHNICK
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_ERR_USERONCHANNEL
·
LIBIRC_RFC_ERR_ERR_CHANOPRIVSNEEDED

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_names

Prototype:

int irc_cmd_names (irc_session_t * session, const char * channel);

Parameters:

sessionIRC session handle
channelA channel name(s) to obtain user list. Multiple channel names must be separated by a comma

Description:

This function is used to to ask the IRC server for the list of the users who are joined the specified channel. You can list all nicknames that are visible to you on any channel that you can see. The list of users will be returned using LIBIRC_RFC_RPL_NAMREPLY and LIBIRC_RFC_RPL_ENDOFNAMES numeric codes.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

The channel names are returned by event_numeric event using the following reply codes:
·
LIBIRC_RFC_RPL_NAMREPLY
·
LIBIRC_RFC_RPL_ENDOFNAMES

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_list

Prototype:

int irc_cmd_list(irc_session_t * session, const char * channel)

Parameters:

sessionIRC session handle
channelA channel name(s) to list. Multiple channel names must be separated by a comma. If NULL, all channels are listed

Description:

This function is used to ask the IRC server for the active (existing) channels list. The list will be returned using the LIBIRC_RFC_RPL_LISTSTART, multiple LIBIRC_RFC_RPL_LIST, and LIBIRC_RFC_RPL_LISTEND event sequence. Note that "private" channels are listed (without their topics) as channel "Prv" unless the client generating the LIST query is actually on that channel. Likewise, secret channels are not listed at all unless the client is active at the channel in question.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

The list of channels is returned by event_numeric event using the following reply codes:
·
LIBIRC_RFC_RPL_LISTSTART
·
LIBIRC_RFC_RPL_LISTEND
·
LIBIRC_RFC_RPL_LIST

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_topic

Prototype:

int irc_cmd_topic(irc_session_t * session, const char * channel, const char * topic)

Parameters:

sessionIRC session handle
channelA channel name
topicA new channel topic. If NULL, the old topic would be returned and nothing would change. To set the empty topic use ""

Description:

This function is used to change or view the topic (title) of a channel. Note that depending on +t channel mode, you may be required to be a channel operator to change the channel topic.

If the command succeeds, the IRC server will generate a LIBIRC_RFC_RPL_NOTOPIC or LIBIRC_RFC_RPL_TOPIC message, containing either the old or changed topic. Also the IRC server can (but does not have to) generate the non-RFC LIBIRC_RFC_RPL_TOPIC_EXTRA message, containing the nick of person who changed the topic, and the date/time of the last change.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

The topic information is returned using one of following reply codes:
·
LIBIRC_RFC_RPL_NOTOPIC
·
LIBIRC_RFC_RPL_TOPIC

If the topic change was requested and it was successfully changed, the event_topic is generated as well.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NEEDMOREPARAMS
·
LIBIRC_RFC_ERR_CHANOPRIVSNEEDED
·
LIBIRC_RFC_ERR_NOTONCHANNEL

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_channel_mode

Prototype:

int irc_cmd_channel_mode(irc_session_t * session, const char * channel, const char * mode)

Parameters:

sessionIRC session handle
channelA channel name
modeA mode to change. If NULL, the channel mode is not changed but the old mode is returned

Description:

This function is used to is used to change or view the channel modes. Note that only the channel operators can change the channel mode.

Channel mode is represended by the multiple letters combination. Every letter has its own meaning in channel modes. Most channel mode letters are boolean (i.e. could only be set or reset), but a few channel mode letters accept a parameter. All channel options are set by adding a plus sign before the letter, and reset by adding a minus sign before the letter.

Here is the list of 'standard' channel modes:

o nicknamegives (+o nickname) to, or takes (-o nickname) the channel operator privileges from a nickname. This mode affects the users in channel, not the channel itself. Examples: "+o tim", "-o watson"
psets (+p) or resets (-p) private channel flag. Private channels are shown in channel list as 'Prv', without the topic
ssets (+s) or resets (-s) secret channel flag. Secret channels aren't shown in channel list at all
isets (+i) or resets (-i) invite-only channel flag. When the flag is set, only the people who are invited by the irc_cmd_invite() can join this channel
tallows (+t) or denies (-t) changing the topic by the non-channel operator users. When the flag is set, only the channel operators can change the channel topic
nsets (+n) or resets (-n) the protection from the users who did not join the channel. When the +n mode is set, only the users who have joined the channel can send the messages to the channel
msets (+m) or resets (-m) the moderation of the channel. When the moderation mode is set, only channel operators and the users who have +v user mode can speak in the channel
v nicknamegives (+v nick) or takes (-v nick) from user the ability to speak on a moderated channel. Examples: "+v bob", "-v joy"
l numbersets (+l 20) or removes (-l) the restriction of maximum number of users allowed in channel. When the restriction is set and there is a number of users in the channel, no one can join the channel anymore
k keysets (+k password) or removes (-k) the password from the channel. When the restriction is set, any user joining the channel required to provide a channel key
b masksets (+b !*@.mil) or removes (-b !*@.mil) the ban mask on a user to keep him out of channel. Note that to remove the ban you must specify the ban mask to remove, not just "-b".

Note that the actual list of channel modes depends on the IRC server, and can be bigger. If you know the popular channel modes which aren't listed here - please contact me

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

The old mode information is returned by using following numeric codes:
·
LIBIRC_RFC_RPL_CHANNELMODEIS
·
LIBIRC_RFC_RPL_BANLIST
·
LIBIRC_RFC_RPL_ENDOFBANLIST
Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NEEDMOREPARAMS
·
LIBIRC_RFC_ERR_CHANOPRIVSNEEDED
·
LIBIRC_RFC_ERR_NOSUCHNICK
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_KEYSET
·
LIBIRC_RFC_ERR_UNKNOWNMODE
·
LIBIRC_RFC_ERR_NOSUCHCHANNEL

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_user_mode

Prototype:

int irc_cmd_user_mode(irc_session_t * session, const char * mode)

Parameters:

sessionIRC session handle
modeA mode to change. If NULL, the user mode is not changed but the old mode is returned

Description:

This function is used to change or view the user modes. Note that, unlike channel modes, some user modes cannot be changed at all.

User mode is represended by the letters combination. All the user mode letters are boolean (i.e. could only be set or reset), they are set by adding a plus sign before the letter, and reset by adding a minus sign before the letter.

Here is the list of 'standard' user modes:

orepresents an IRC operator status. Could not be set directly (but can be reset though), to set it use the IRC a OPER command
iif set, marks a user as 'invisible' - that is, not seen by lookups if the user is not in a channel
wif set, marks a user as 'receiving wallops' - special messages generated by IRC operators using WALLOPS command
sif set, marks a user for receipt of server notices
rNON-STANDARD MODE. If set, user has been authenticated with the NickServ IRC service
xNON-STANDARD MODE. If set, user's real IP is masked by the IRC server

Note that the actual list of user modes depends on the IRC server, and can be bigger. If you know the popular user modes, which aren't mentioned here - please contact me.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

The old mode information is returned by using the numeric code LIBIRC_RFC_RPL_UMODEIS:

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NEEDMOREPARAMS
·
LIBIRC_RFC_ERR_NOSUCHNICK
·
LIBIRC_RFC_ERR_UNKNOWNMODE
·
LIBIRC_RFC_ERR_USERSDONTMATCH
·
LIBIRC_RFC_ERR_UMODEUNKNOWNFLAG

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_kick

Prototype:

int irc_cmd_kick (irc_session_t * session, const char * nick, const char * channel, const char * reason);

Parameters:

sessionIRC session handle
nickThe nick to kick
channelThe channel to kick the nick from
nickIf not NULL, the reason to kick the user

Description:

This function is used to kick a person out of channel. Note that you must be a channel operator to kick anyone from a channel.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

If the command succeed, the event_kick will be generated.

If the command failed, one of the following event_numeric responses will be generated:
·
LIBIRC_RFC_ERR_NEEDMOREPARAMS
·
LIBIRC_RFC_ERR_BADCHANMASK
·
LIBIRC_RFC_ERR_NOSUCHCHANNEL
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_CHANOPRIVSNEEDED

Thread safety:

This function can be called simultaneously from multiple threads.

Sending the messages, notices, /me messages and working with CTCP

irc_cmd_msg

Prototype:

int irc_cmd_msg(irc_session_t * session, const char * nch, const char * text)

Parameters:

sessionIRC session handle
nchTarget nick or target channel
textMessage text

Description:

This function is used to send the message to the channel or privately to another nick. "Privately" here means the message is not posted to the public, but the message still goes through the IRC server and could be seen by the IRC netwrk operators. The message target is determined by the nch argument: if it is a nick, this will be a private message, but if it is a channel name it will be posted into the channel.

The protocol does not require you to join the channel to post the message into it, but most channels set the channel mode preventing you from posting into a channel unless you join it.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed. You need to wait for the appropriate event or for the error code via event_numeric event.

If the command succeed, no event is typically generated except the possibility of LIBIRC_RFC_RPL_AWAY.

However if the command failed, one of the following numeric events may be generated:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_me

Prototype:

int irc_cmd_me(irc_session_t * session, const char * nch, const char * text)

Parameters:

sessionIRC session handle
nchTarget nick or target channel
textMessage text

Description:

This function is used to send the /me message (CTCP ACTION) to the channel or privately to another nick. "Privately" here means the message is not posted to the public, but the message still goes through the IRC server and could be seen by the IRC netwrk operators. The message target is determined by the nch argument: if it is a nick, this will be a private message, but if it is a channel name it will be posted into the channel.

The protocol does not require you to join the channel to post the message into it, but most channels set the channel mode preventing you from posting into a channel unless you join it.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed. You need to wait for the appropriate event or for the error code via event_numeric event.

If the command succeed, no event is typically generated except the possibility of LIBIRC_RFC_RPL_AWAY.

However if the command failed, one of the following numeric events may be generated:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_notice

Prototype:

int irc_cmd_notice(irc_session_t * session, const char * nch, const char * text)

Parameters:

sessionIRC session handle
nchTarget nick or target channel
textMessage text

Description:

This function is used to send the notice to the channel or privately to another nick. "Privately" here means the message is not posted to the public, but the message still goes through the IRC server and could be seen by the IRC netwrk operators. The message target is determined by the nch argument: if it is a nick, this will be a private message, but if it is a channel name it will be posted into the channel.

The protocol does not require you to join the channel to post the notice into it, but most channels set the channel mode preventing you from posting into a channel unless you join it.

The only difference between a message and a notice is that the RFC explicitly says the automatic bots must not reply to NOTICE automatically.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

If the command succeed, no event is typically generated except the possibility of LIBIRC_RFC_RPL_AWAY.

However if the command failed, one of the following numeric events may be generated:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_ctcp_request

Prototype:

int irc_cmd_ctcp_request(irc_session_t * session, const char * nick, const char * request)

Parameters:

sessionIRC session handle
nickTarget nick
requestCTCP request tex

Description:

This function is used to send a CTCP request. There are four CTCP requests supported by most IRC clients:

·
VERSION - get the client software name and version
·
FINGER - get the client username, host and real name.
·
PING - get the client delay.
·
TIME - get the client local time.

Some clients may support other requests. The RFC does not list the requests and does not mandate any CTCP support.

If you send the CTCP request, make sure you define the handler for the event_ctcp_rep to process the reply;

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_ctcp_reply

Prototype:

int irc_cmd_ctcp_reply(irc_session_t * session, const char * nick, const char * reply)

Parameters:

sessionIRC session handle
nickTarget nick
replyCTCP reply

Description:

This function is used to send a reply to the CTCP request received from event_ctcp_req event. Note that you will not receive this event unless you specify your own handler during the IRC session initialization.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

Miscellaneous: library version, raw data, changing nick, quitting

irc_cmd_nick

Prototype:

int irc_cmd_nick(irc_session_t * session, const char * newnick)

Parameters:

sessionIRC session handle
nickNew nick

Description:

This function is used to change your current nick to another nick. Note that such a change is not always possible; for example you cannot change nick to the existing nick, or (on some servers) to the registered nick.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

If the operation succeed, the server will send the event_nick event. If not, it will send a numeric error. Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NONICKNAMEGIVEN
·
LIBIRC_RFC_ERR_ERRONEUSNICKNAME
·
LIBIRC_RFC_ERR_NICKNAMEINUSE
·
LIBIRC_RFC_ERR_NICKCOLLISION

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_whois

Prototype:

int irc_cmd_whois(irc_session_t * session, const char * nick)

Parameters:

sessionIRC session handle
nickNick or comma-separated list of nicks to query the information about

Description:

This function queries various information about the nick. The amount of information depends on the IRC server but typically includes username, real name (as defined by the client at login), the IRC server used, the channels user is in, idle time, away mode and so on.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event_numeric event.

If the request succeed, the information is returned through the following numeric codes which return the information:
·
LIBIRC_RFC_RPL_WHOISUSER
·
LIBIRC_RFC_RPL_WHOISCHANNELS
·
LIBIRC_RFC_RPL_WHOISSERVER
·
LIBIRC_RFC_RPL_AWAY
·
LIBIRC_RFC_RPL_WHOISOPERATOR
·
LIBIRC_RFC_RPL_WHOISIDLE
·
LIBIRC_RFC_RPL_ENDOFWHOIS - this event terminates the WHOIS information
Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NOSUCHSERVER
·
LIBIRC_RFC_ERR_NOSUCHNICK
·
LIBIRC_RFC_ERR_NONICKNAMEGIVEN

Thread safety:

This function can be called simultaneously from multiple threads.

irc_cmd_quit

Prototype:

int irc_cmd_quit(irc_session_t * session, const char * reason)

Parameters:

sessionIRC session handle
reasonIf not NULL, the reason to quit

Description: This function sends the QUIT command to the IRC server. This command forces the IRC server to close the IRC connection, and terminate the session.

The difference between this command and calling the irc_disconnect is that this command allows to specify the reason to quit which will be shown to all the users in the channels you joined. Also it would make it clear that you left the IRC channels by purpose, and not merely got disconnected.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_send_raw

Prototype:

int irc_send_raw (irc_session_t * session, const char * format, ...);

Parameters:

sessionIRC session handle
formatprintf-type formatting string followed by the format arguments

Description:

This function sends the raw data as-is to the IRC server. Use it to generate a server command, which is not (yet) provided by libircclient directly.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_target_get_nick

Prototype:

void irc_target_get_nick(const char * origin, char *nick, size_t size)

Parameters:

originNick in the common IRC server format such as tim!root@mycomain.com
nickBuffer to retrieve the parsed nick name
sizeSize of the nick buffer. If the parsed nick is larger than the buffer size it will be truncated

Description:

For most events IRC server returns 'origin' (i.e. the person, who generated this event) in so-called "common" form, like nick!host@domain. However, all the irc_cmd_* functions require just a nick. This function parses this origin, and retrieves the nick, storing it into the user-provided buffer.

A buffer of size 128 should be enough for most nicks.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_target_get_host

Prototype:

void irc_target_get_host(const char * target, char *host, size_t size)

Parameters:

originNick in the common IRC server format such as tim!root@mycomain.com
hostBuffer to retrieve the parsed hostname
sizeSize of the host buffer. If the parsed nick is larger than the buffer size it will be truncated

Description:

For most events IRC server returns 'origin' (i.e. the person, who generated this event) in so-called "common" form, like nick!host@domain. This function parses this origin, and retrieves the host, storing it into the user-provided buffer.

Thread safety:

This function can be called simultaneously from multiple threads.

DCC initiating and accepting chat sessions, sending and receiving files

irc_dcc_chat

Prototype:

int irc_dcc_chat(irc_session_t * session, void * ctx, const char * nick, irc_dcc_callback_t callback, irc_dcc_t * dccid)

Parameters:

sessionIRC session handle
ctxUser-defined context which will be passed to the callback. May be NULL
nickTarget nick
callbackDCC callback which will be used for DCC and chat events
dccidIf this function succeeds, the DCC session identifier is stored in this field

Description:

This function requests a DCC CHAT between you and other IRC user. DCC CHAT is like private chat, but it goes directly between two users, and bypasses the IRC server. DCC CHAT request must be accepted by other side before you can send anything.

When the chat is accepted, declined, terminated, or some data is received, the callback function is called. To be specific, the callback will be called when:

·
The chat request is accepted;
·
The chat request is denied;
·
The new chat message is received;
·
The chat is terminated by the remote party;

See the details in irc_dcc_callback_t declaration.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_dcc_msg

Prototype:

int irc_dcc_msg(irc_session_t * session, irc_dcc_t dccid, const char * text)

Parameters:

sessionIRC session handle
dccidDCC session identifier for the DCC CHAT session which is active
textNULL-terminated message to send

Description:

This function is used to send the DCC CHAT message to an active DCC CHAT. To be active, DCC CHAT request must be initiated by one side and accepted by another side.

Return value:

Return code 0 means success. Other value means error, the error code may be obtained through irc_errno().

Thread safety:

This function can be called simultaneously from multiple threads.

irc_dcc_accept

Prototype:

int irc_dcc_accept(irc_session_t * session, irc_dcc_t dccid, void * ctx, irc_dcc_callback_t callback)

Parameters:

sessionIRC session handle
dccidDCC session identifier returned by the callback
ctxUser-defined context which will be passed to the callback. May be NULL
callbackDCC callback which will be used for DCC and chat events

Description:

This function accepts a remote DCC chat or file transfer request. After the request is accepted the callback will be called for the further DCC events, including the termination of the DCC session. See the DCC callback information.

This function should be called only after either event_dcc_chat_req or event_dcc_send_req events are received. You don't have to call irc_dcc_accept() or irc_dcc_decline() immediately in the event processing function - you may just store the dccid and return, and call those functions later. However to prevent memory leaks you must call either irc_dcc_decline() or irc_dcc_accept() for any incoming DCC request within 60 seconds after receiving it.

Return value:

Return code 0 means success. Other value means error, the error code may be obtained through irc_errno().

Thread safety:

This function can be called simultaneously from multiple threads.

irc_dcc_decline

Prototype:

int irc_dcc_decline(irc_session_t * session, irc_dcc_t dccid)

Parameters:

sessionIRC session handle
dccidDCC session identifier returned by the callback

Description:

This function declines a remote DCC chat or file transfer request.

This function should be called only after either event_dcc_chat_req or event_dcc_send_req events are received. You don't have to call irc_dcc_accept() or irc_dcc_decline() immediately in the event processing function - you may just store the dccid and return, and call those functions later. However to prevent memory leaks you must call either irc_dcc_decline() or irc_dcc_accept() for any incoming DCC request within 60 seconds after receiving it.

Do not use this function to forecefully close the previously accepted or initiated DCC session. Use irc_dcc_destroy() instead.

Return value:

Return code 0 means success. Other value means error, the error code may be obtained through irc_errno().

Thread safety:

This function can be called simultaneously from multiple threads.

irc_dcc_sendfile

Prototype:

int irc_dcc_sendfile(irc_session_t * session, void * ctx, const char * nick, const char * filename, irc_dcc_callback_t callback, irc_dcc_t * dccid)

Parameters:

sessionIRC session handle
ctxUser-defined context which will be passed to the callback. May be NULL
nickTarget nick
filenameFull path to the file which will be sent. Must be an existing file
callbackDCC callback which will be used for DCC and chat events
dccidIf this function succeeds, the DCC session identifier is stored in this field

Description:

This function generates a DCC SEND request to send the file. When it is accepted, the file is sent to the remote party, and the DCC session is closed. The send operation progress and result can be checked in the callback. See the DCC callback information.

Return value:

Return code 0 means the command was sent to the IRC server successfully. This does not mean the operation succeed, and you need to wait for the appropriate event or for the error code via event_numeric event.

Possible error responces for this command from the RFC1459:
·
LIBIRC_RFC_ERR_NORECIPIENT
·
LIBIRC_RFC_ERR_NOTEXTTOSEND
·
LIBIRC_RFC_ERR_CANNOTSENDTOCHAN
·
LIBIRC_RFC_ERR_NOTONCHANNEL
·
LIBIRC_RFC_ERR_NOTOPLEVEL
·
LIBIRC_RFC_ERR_WILDTOPLEVEL
·
LIBIRC_RFC_ERR_TOOMANYTARGETS
·
LIBIRC_RFC_ERR_NOSUCHNICK

Thread safety:

This function can be called simultaneously from multiple threads.

irc_dcc_destroy

Prototype:

int irc_dcc_destroy(irc_session_t * session, irc_dcc_t dccid)

Parameters:

sessionIRC session handle
dccidDCC session identifier of a session to destroy

Description:

This function closes the DCC connection (if available), and destroys the DCC session, freeing the used resources. It can be called anytime, even from callbacks or from different threads.

Note that when DCC session is finished (either with success or failure), you should not destroy it - it will be destroyed automatically.

Return value:

Return code 0 means success. Other value means error, the error code may be obtained through irc_errno().

Thread safety:

This function can be called simultaneously from multiple threads.

Handling the colored messages

irc_color_strip_from_mirc

Prototype:

char * irc_color_strip_from_mirc(const char * message)

Parameters:

messageOriginal message with colors

Description:

This function strips all the ANSI color codes from the message, and returns a new message with no color information. Useful for the bots which react to strings, to make sure the bot is not confused if the string uses colors.

This function does not modify the message which doesn't use colors.

Return value:

Returns a new message with stripped color codes. Note that the memory for the new message is allocated using malloc(), so you should free it using free() when it is not used anymore. If memory allocation failed, returns 0.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_color_convert_from_mirc

Prototype:

char * irc_color_convert_from_mirc(const char * message)

Parameters:

messageOriginal message with colors

Description:

This function converts all the color codes and format options to libircclient internal colors.

Return value:

Returns a pointer to the new message with converted ANSI color codes and format options. See the irc_color_convert_to_mirc help for details.

Note that the memory for the new message is allocated using malloc(), so you should free it using free() when it is not used anymore. If memory allocation failed, returns 0.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_color_convert_to_mirc

Prototype:

char * irc_color_convert_to_mirc(const char * message)

Parameters:

messageOriginal message with colors

Description:

This function converts all the color codes and format options from internal libircclient colors to ANSI used by mIRC and other IRC clients.

Return value:

Returns a new message with converted color codes and format options, or 0 if memory could not be allocated. Note that the memory for the new message is allocated using malloc(), so you should free it using free() when it is not used anymore.

Thread safety:

This function can be called simultaneously from multiple threads.

The color system of libircclient is designed to be easy to use, and portable between different IRC clients. Every color or format option is described using plain text commands written between square brackets.

The possible codes are:
·
[B] ... [/B] - bold format mode. Everything between [B] and [/B] is written in bold.
·
[I] ... [/I] - italic/reverse format mode. Everything between [I] and [/I] is written in italic, or reversed (however, because some clients are incapable of rendering italic text, most clients display this as normal text with the background and foreground colors swapped).
·
[U] ... [/U] - underline format mode. Everything between [U] and [/U] is written underlined.
·
[COLOR=RED] ... [/COLOR] - write the text using specified foreground color. The color is set by using the COLOR keyword, and equal sign followed by text color code (see below).
·
[COLOR=RED/BLUE] ... [/COLOR] - write the text using specified foreground and background color. The color is set by using the COLOR keyword, an equal sign followed by text foreground color code, a dash and a text background color code.
The following colors are supported:
·
WHITE
·
BLACK
·
DARKBLUE
·
DARKGREEN
·
RED
·
BROWN
·
PURPLE
·
OLIVE
·
YELLOW
·
GREEN
·
TEAL
·
CYAN
·
BLUE
·
MAGENTA
·
DARKGRAY
·
LIGHTGRAY

Examples of color sequences:

Hello, [B]Tim[/B].
[U]Arsenal[/U] got a [COLOR=RED]red card[/COLOR]
The tree[U]s[/U] are [COLOR=GREEN/BLACK]green[/COLOR]

Changing the library options

irc_get_version

Prototype:

void irc_get_version(unsigned int * high, unsigned int * low)

Parameters:

highStores the high version number
lowStores the low version number

Description:

This function returns the libircclient version. You can use the version either to check whether required options are available, or to output the version. The preferred printf-like format string to output the version is:

printf ("Version: %d.%02d", high, low);

Thread safety:

This function can be called simultaneously from multiple threads.

irc_set_ctx

Prototype:

void irc_set_ctx(irc_session_t * session, void * ctx)

Parameters:

sessionIRC session handle
ctxUser-defined context

Description:

This function sets the user-defined context for this IRC session. This context is not used by libircclient. Its purpose is to store session-specific user data, which may be obtained later by calling irc_get_ctx. Note that libircclient just carries out this pointer. If you allocate some memory, and store its address in ctx (most common usage), it is your responsibility to free it before calling irc_destroy_session().

Thread safety:

This function can be called simultaneously from multiple threads.

irc_get_ctx

Prototype:

void * irc_get_ctx(irc_session_t * session)

Parameters:

sessionIRC session handle

Description:

This function returns the IRC session context, which was set by irc_set_ctx.

Return value:

If no context was set, this function returns NULL.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_option_set

Prototype:

void irc_option_set(irc_session_t * session, unsigned int option)

Parameters:

sessionIRC session handle
optionOne of the Libirc options to set

Description:

This function sets the libircclient option, changing libircclient behavior. See the options list for the meaning for every option.

Thread safety:

This function can be called simultaneously from multiple threads.

irc_option_reset

Prototype:

void irc_option_reset(irc_session_t * session, unsigned int option)

Parameters:

sessionIRC session handle
optionOne of the Libirc options to set

Description:

This function resets the libircclient option, changing libircclient behavior. See the options list for the meaning for every option.

Thread safety:

This function can be called simultaneously from multiple threads.

Handling the errors

irc_errno

Prototype:

int irc_errno(irc_session_t * session)

Parameters:

sessionIRC session handle

Description:

This function returns the last error code associated with last operation of this IRC session. Possible error codes are defined in libirc_errors.h

As usual, typical errno rules apply:

·
irc_errno() should be called ONLY if the called function fails;
·
irc_errno() doesn't return 0 if function succeed; actually, the return value will be undefined.
·
you should call irc_errno() IMMEDIATELY after function fails, before calling any other libircclient function.

Return value:

The error code.

Thread safety:

This function can be called simultaneously from multiple threads. Local error code is per IRC context, not per thread.

irc_strerror

Prototype:

const char * irc_strerror(int ircerrno)

Parameters:

ircerrnoIRC error code returned by irc_errno()

Description:

This function returns the text representation of the given error code.

Return value:

Returns an internal English string with a short description of the error code.

Thread safety:

This function can be called simultaneously from multiple threads.

Types

This section describes various types defined by the library.

irc_session_t

typedef struct irc_session_s irc_session_t

The IRC session handle created by callind irc_create_session(). Most of the library function calls expect this handle as a parameter. You can create as many handles as you want. Each handle could be used to establish a single IRC connection to an IRC server as a single user.

Once the handle is not used anymore, it should be destroyed by calling irc_destroy_session().

irc_dcc_session_t

typedef struct irc_dcc_session_s irc_dcc_session_t

This structure describes a DCC session used by libircclient. Its members are internal to libircclient, and should not be used directly.

irc_dcc_t

typedef unsigned int irc_dcc_t

This type is a DCC session identifier, used to identify the DCC sessions in callbacks and various functions.

irc_callbacks_t

typedef struct irc_callbacks_t

typedef struct
{
  irc_event_callback_t         event_connect;
  irc_event_callback_t         event_nick;
  irc_event_callback_t         event_quit;
  irc_event_callback_t         event_join;
  irc_event_callback_t         event_part;
  irc_event_callback_t         event_mode;
  irc_event_callback_t         event_umode;
  irc_event_callback_t         event_topic;
  irc_event_callback_t         event_kick;
  irc_event_callback_t         event_channel;
  irc_event_callback_t         event_privmsg;
  irc_event_callback_t         event_notice;
  irc_event_callback_t         event_channel_notice;
  irc_event_callback_t         event_invite;
  irc_event_callback_t         event_ctcp_req;
  irc_event_callback_t         event_ctcp_rep;
  irc_event_callback_t         event_ctcp_action;
  irc_event_callback_t         event_unknown;
  irc_eventcode_callback_t     event_numeric;
  irc_event_dcc_chat_t         event_dcc_chat_req;
  irc_event_dcc_send_t         event_dcc_send_req;
}

Describes the event callbacks structure which is used in registering the callbacks.

All the communication with the IRC network is based on events. Generally speaking, event is anything generated by someone else in the network, or by the IRC server itself. "Someone sends you a message", "Someone has joined the channel", "Someone has quits IRC" - all these messages are events.

Every event has its own event handler, which is called when the appropriate event is received. You don't have to define all the event handlers; define only the handlers for the events you need to intercept, and set the remaining handler pointers to NULL.

event_connect

This event is triggered when the connection to the IRC server is successfully established, and the MOTD is received. Depending on the server it may also be possible to send the commands before this event.

This event uses irc_event_callback_t callback with the following values:

originUnused, set to NULL
paramsUnused, set to NULL

event_nick

This event is triggered when the NICK message is received. It happens when one of the users (including you) in one of the channels you are watching (have joined) changed their nick.

Changing your own nick will also generate this event. Note that the server may change your nick independently, so you must track this event.

This event uses irc_event_callback_t callback with the following values:

originThe original nick (may be yours!)
paramsparams[0] contains a new nick.

event_quit

This event is triggered when the QUIT message is received. It happens when one of the users in one of the channels you are watching (have joined) disconnected from the IRC server.

This event uses irc_event_callback_t callback with the following values:

originThe user who disconnected
paramsparams[0] is optional, contains the user-specified reason to quit

event_join

This event is triggered upon receipt of a JOIN message. It happens when a new user joins the channel you are watching (have joined). It also happens when you joined the new channel.

Note that you may be "forced" to join the channel (and therefore receive this event) without issuing the JOIN command. A typical case is when the NickServ bot on the server is configured to auto-join you to specific channels.

This event uses irc_event_callback_t callback with the following values:

originThe user who joined the channel (this may be you!)
paramsparams[0] contains the channel name

event_part

This event is triggered upon receipt of a PART message. It happens when a user leaves the channel you are watching (have joined). It also happens when you leave a channel.

This event uses irc_event_callback_t callback with the following values:

originThe user who left the channel (this may be you!)
paramsparams[0] contains the channel name params[1] is optional and contains the user-specified reason

event_mode

This event is triggered upon receipt of a channel MODE message. It happens when someone changed the mode(s) of the channel you are watching (have joined).

This event uses irc_event_callback_t callback with the following values:

originThe user who performed the change
paramsparams[0] contains the channel name params[1] contains the channel mode changes, such as "+t", "-i" params[2] optional, contains the argument for the channel mode (for example, a nick for the +o mode)

event_umode

This event is triggered upon receipt of a user MODE message. It happens when your user mode is changed.

This event uses irc_event_callback_t callback with the following values:

originThe user who performed the change
paramsparams[0] contains the channel name params[1] contains the user mode changes, such as "+t", "-i"

event_topic

This event is triggered upon receipt of a TOPIC message. It happens when someone changed the topic on the channel you are watching (have joined).

This event uses irc_event_callback_t callback with the following values:

originThe user who performed the change
paramsparams[0] contains the channel name params[1] optional, contains the new topic

event_kick

This event is triggered upon receipt of a KICK message. It happens when someone (including you) kicked someone (including you) from the channel you are watching (have joined).

It is possible to kick yourself from the channel.

This event uses irc_event_callback_t callback with the following values:

originThe user who performed the action (may be you)
paramsparams[0] contains the channel name params[1] optional, contains the nick of the kicked params[2] optional, contains the reason for the kick

event_channel

This event is triggered upon receipt of a PRIVMSG message sent to the channel. It happens when someone (but not you) sent a message to the channel you are watching (have joined).

Your own messages do not trigger this event. However the server can still "force" you to send a message to the channel by generating this event.

This event uses irc_event_callback_t callback with the following values:

originThe user who sent a message
paramsparams[0] contains the channel name params[1] optional, contains the message text

event_privmsg

This event is triggered upon receipt of a PRIVMSG message sent privately to you. It happens when someone sent you a message.

This event uses irc_event_callback_t callback with the following values:

originThe user who sent a message
paramsparams[0] contains your nick params[1] optional, contains the message text

event_notice

This event is triggered upon receipt of a NOTICE message. This message is similar to PRIVMSG and matches the event_privmsg. According to RFC 1459, the only difference between NOTICE and PRIVMSG is that you should NEVER automatically reply to NOTICE messages. Unfortunately, this rule is frequently violated by IRC servers itself - for example, NICKSERV messages require reply, and are sent as NOTICE.

This event uses irc_event_callback_t callback with the following values:

originThe user who sent a message
paramsparams[0] contains the target nick name params[1] optional, contains the message text

event_channel_notice

This event is triggered upon receipt of a NOTICE message. This message is similar to PRIVMSG and matches the event_channel. According to RFC 1459, the only difference between NOTICE and PRIVMSG is that you should NEVER automatically reply to NOTICE messages. Unfortunately, this rule is frequently violated by IRC servers itself - for example, NICKSERV messages require reply, and are sent as NOTICE.

This event uses irc_event_callback_t callback with the following values:

originThe user who sent a message
paramsparams[0] contains the channel name params[1] optional, contains the message text

event_invite

This event is triggered upon receipt of an INVITE message. It happens when someone invited you to a channel which has +i (invite-only) mode.

This event uses irc_event_callback_t callback with the following values:

originThe user who invited you
paramsparams[0] contains your nick params[1] optional, contains the channel name

See also: irc_cmd_invite()

event_ctcp_req

This event is triggered upon receipt of an CTCP request. By default, the built-in CTCP request handler is used.

Mirc generates PING, FINGER, VERSION, TIME and ACTION messages which are automatically handled by the library if this event is not handled by your application. Those messages are replied automatically except the ACTION message which triggers event_ctcp_action event. If you need to handle more types of the message, define this event handler, and check the source code of libirc_event_ctcp_internal function to see how to write your own CTCP request handler. Note that you must support at least CTCP PING to pass the spoof check by some IRC servers.

Also you may find useful this question in FAQ: ref faq4

This event uses irc_event_callback_t callback with the following values:

originThe user who generated the message
paramsparams[0] contains the complete CTCP message

event_ctcp_rep

This event is triggered upon receipt of an CTCP response. Thus if you generate the CTCP message and the remote user responded, this event handler will be called.

This event uses irc_event_callback_t callback with the following values:

originThe user who generated the message
paramsparams[0] contains the complete CTCP message

event_ctcp_action

This event is triggered upon receipt of an CTCP ACTION message. It is only invoked if you did not define the event_ctcp_req event handler.

Such messages typically look like that in the IRC client:

::
[08:32:55] * Michael is having fun [08:32:55] * Bobby's getting jealous

This event uses irc_event_callback_t callback with the following values:

originThe user who generated the message
paramsparams[0] contains the content of ACTION message

event_unknown

This event is triggered upon receipt of an unknown message which is not handled by the library.

This event uses irc_event_callback_t callback with the following values:

originThe user who generated the event
paramsZero or more parameters provided with the event

event_numeric

This event is triggered upon receipt of every numeric message from the server. The incomplete list of those responses could be found in RFC 1429. This event is necessary to handle for any meaningful client.

This event uses the dedicated

irc_eventcode_callback_t_

callback. See the callback documentation.

event_dcc_chat_req

This event is triggered when someone attempts to establish the DCC CHAT with you.

This event uses the dedicated irc_event_dcc_chat_t callback. See the callback documentation.

event_dcc_send_req

This event is triggered when someone attempts to send you the file via DCC SEND.

This event uses the dedicated irc_event_dcc_send_t callback. See the callback documentation.

Constants

This section describes contstants such as options and the error codes.

Errors

LIBIRC_ERR_OK

(0): No error

LIBIRC_ERR_INVAL

(1): An invalid value was given for one of the arguments to a function. For example, supplying the NULL value as a channel argument of irc_cmd_join() produces this error.

LIBIRC_ERR_RESOLV

(2): The host name supplied for irc_connect() function could not be resolved into valid IP address.

LIBIRC_ERR_SOCKET

(3): The new socket could not be created or made non-blocking. Usually means that the server is out of resources, or (hopefully not) a bug in libircclient. See also faq_err_socket

LIBIRC_ERR_CONNECT

(4): The socket could not connect to the IRC server, or to the destination DCC part. Usually means that either the IRC server is down or its address is invalid. For DCC the reason usually is the firewall on your or destination computer, which refuses DCC transfer.

LIBIRC_ERR_CLOSED

(5): The IRC connection was closed by the IRC server (which could mean that an IRC operator just have banned you from the server - test your client before connecting to a public server), or the DCC connection was closed by remote peer - for example, the other side just terminates the IRC application. Usually it is not an error.

LIBIRC_ERR_NOMEM

(6): There are two possible reasons for this error. First is that memory could not be allocated for libircclient internal use, and this error is usually fatal. Second reason is that the command buffer (which queues the commands ready to be sent to the IRC server) is full, and could not accept more commands yet. In the last case you should just wait, and repeat the command later.

LIBIRC_ERR_ACCEPT

(7): A DCC chat/send connection from the remote peer could not be accepted. Either the connection was just terminated before it is accepted, or there is a bug in libircclient.

LIBIRC_ERR_NODCCSEND

(9): A filename supplied to irc_dcc_sendfile() could not be sent. Either is is not a regular file (a directory or a socket, for example), or it could not be read. See also LIBIRC_ERR_OPENFILE

LIBIRC_ERR_READ

(10): Either a DCC file could not be read (for example, was truncated during sending), or a DCC socket returns a read error, which usually means that the network connection is terminated.

LIBIRC_ERR_WRITE

(11): Either a DCC file could not be written (for example, there is no free space on disk), or a DCC socket returns a write error, which usually means that the network connection is terminated.

LIBIRC_ERR_STATE

(12): The function is called when it is not allowed to be called. For example, irc_cmd_join() was called before the connection to IRC server succeed, and event_connect is called.

LIBIRC_ERR_TIMEOUT

(13): The DCC request is timed out. There is a timer for each DCC request, which tracks connecting, accepting and non-accepted/declined DCC requests. For every request this timer is currently set to 60 seconds. If the DCC request was not connected, accepted or declined during this time, it will be terminated with this error.

LIBIRC_ERR_OPENFILE

(14): The file specified in irc_dcc_sendfile() could not be opened.

LIBIRC_ERR_TERMINATED

(15): The connection to the IRC server was terminated.

LIBIRC_ERR_NOIPV6

(16): The function which requires IPv6 support was called, but the IPv6 support was not compiled into the application

LIBIRC_ERR_SSL_NOT_SUPPORTED

(17): The SSL connection was required but the library was not compiled with SSL support

LIBIRC_ERR_SSL_INIT_FAILED

(18): The SSL library could not be initialized.

LIBIRC_ERR_CONNECT_SSL_FAILED

(19): SSL handshare failed when attempting to connect to the server. Typically this means you're trying to use SSL but attempting to connect to a non-SSL port.

LIBIRC_ERR_SSL_CERT_VERIFY_FAILED

(20): The server is using an invalid or the self-signed certificate. Use LIBIRC_OPTION_SSL_NO_VERIFY option to connect to it.

Options

LIBIRC_OPTION_DEBUG

If set, enables additional debug output which goes to STDOUT.

LIBIRC_OPTION_STRIPNICKS

If set, strips the event origins automatically. Every event has an origin (i.e. who originated the event). The origin usually looks like nick!host@ircserver, i.e. like tim!home@irc.server.net. Such origins can not be used in IRC commands, and need to be stripped (i.e. host and server part should be cut off) before using. This can be done either manually by calling irc_target_get_nick(), or automatically for all the events if this option is set.

LIBIRC_OPTION_SSL_NO_VERIFY

By default the SSL connection is authenticated by verifying that the certificate presented by the server is signed by a known trusted certificate authority. Since those typically cost money, some IRC servers use the self-signed certificates. They provide the benefits of the SSL connection but since they are not signed by the Certificate Authority, their authencity cannot be verified. This option, if set, disables the certificate verification - the library will accept any certificate presented by the server.

This option must be set before the irc_connect function is called.

Appendix

Frequently asked questions

Why do I get a LIBIRC_ERR_SOCKET error under Win32 when using a static library?

Because on Win32 you have to initialize the Winsock API before using it:

WSADATA wsaData;

if ( WSAStartup ( MAKEWORD (2, 2), &wsaData) != 0 )
    // report an error

// Now you can use libircclient

You have to do it ONCE in your application, and since libircclient does not know whether you already initialized it or not, it does not contain any Winsock initialization code.

What does it mean that the IRC protocol is event-based?

The IRC protocol itself is asynchronous and server-driven. For you, this means the following:

·
For any IRC command, it is not possible to obtain an immediate response whether the command succeed or not. Instead the server will send the reply in a short (or long) period of time.
·
For some IRC command there is no ‘success’ response at all. For example, when you send a text message, IRC server will not send anything to confirm that the message is already sent.
·
You can send several commands to the IRC server, and then receive several replies regarding every command. The order of the replies you receive is generally undefined.
·
A lot of IRC events sent to you is generated by other users, or the IRC server itself, and are sent to you just when they are generated.
·
Long lists (for example, channel lists) are also sent as events. Moreover, these events could be separated by other events (message or notices). And it is your responsibility to separate the data (using event codes), and use some sort of data structure that will hold it until the data is complete. It is not possible to simply query the list of channels, and expect that its content will immediately arrive.
·
You may send the request, and not receive a response in case of success (such as when you send a message). You may send the request and it will only succeed when you receive a response (which may be after you receive ten more unrelated events). Or you can receive a response without even sending a request, as it is the case with JOIN - it is possible for the server to JOIN you to a specific channel implicitly.
·
You should be prepared to expect the unexpected from the IRC server. For example, the server can change your nick (seen on most servers, which use nickserv authentication. You can be “forced” to join the channel, to say something, to leave a channel, to change your usermode and so on. Listen what IRC server tells you, and do so.

Why the irc_cmd_join function does not return an error?

A typical example is the irc_cmd_join() call always returns success even when you attempt to join a password-protected channel. Then some time later the IRC server returns an error. This is because the irc_cmd family of functions return success when the command is sent to the IRC server. The asynchronous nature of IRC makes it impossible to obtain the command result immediately. Please read the question above.

How to register/auth with NICKSERV?

There is no ‘standard’ way. NICKSERV, CHANSERV and so on are not specified by the RFC. They are IRC extensions which behave exactly like the other IRC users but with more power. Typically their messages are sent via Notice events, so you can use following algorithm to handle Nickserv registration:

static void event_notice (irc_session_t * session, const char * event,
                                                 const char * origin, const char ** params, unsigned int count)
{
        char buf[256];

        if ( !origin )
                return;

        if ( strcasecmp (origin, "nickserv") )
                return;

        if ( strstr (params[1], "This nick is not registered") == params[1] )
        {
                sprintf (buf, "REGISTER %s NOMAIL", gCfg.irc_nickserv_password);
                irc_cmd_msg(session, "nickserv", buf);
        }
        else if ( strstr (params[1], "This nickname is registered and protected") == params[1] )
        {
                sprintf (buf, "IDENTIFY %s", gCfg.irc_nickserv_password);
                irc_cmd_msg(session, "nickserv", buf);
        }
        else if ( strstr (params[1], "Password accepted - you are now recognized") == params[1] )
                printf ("Nickserv authentication succeed.");
}

The idea is to parse the messages sent from NICKSERV, and if they’re matched the specific patterns, react on them appropriately.

What is CTCP?

CTCP abbreviature is deciphered as “Client-to-Client Protocol”. It is used between the IRC clients to query the remote client for some data, or to send some information – for example, /me messages are sent via CTCP.

There is no standard list of possible CTCP requests, and different IRC clients often add their own CTCP codes. The built-in handler reacts on TIME, VERSION, PING and FINGER CTCP queries. If you need to react on other requests, you’ll have to write your own CTCP handler. See the source code of libirc_event_ctcp_internal function to get an idea how to write it.

When I am made a chanop (+o) why do I not receive the event_umode?

Becoming a channel operator channes the channel mode, not user mode. Therefore you will receive event_mode and not event_umode

If you receive the event_umode with +o this means your user is an IRC server operator.

What if my application uses epoll?

The library only directly supports the select()-based loops for historic reasons, so epoll and other polling methods are not supported directly by the library. However but if necessart, it could be emulated by converting descriptors between select and epoll as following:

·
Call irc_add_select_descriptors with an empty FD_SET
·
Extract the descriptors from the fd_set arrays (remember fd_array is a bitarray, not the value array). There may be more than one descriptor in case there are DCC sessions.
·
Pass those descriptors to poll/epoll using relevant events (i.e. use the EPOLLIN for the descriptors in the in_set)
·
For those descriptors which triggered the events, fill up the relevant in_set and out_set structures (again, remember the bitmasks!) and pass them to irc_process_select_descriptors()

While this is cumbersome, the operations are very simple (basically bitmask operations on a small structure) and will not add any significant slowdown to your application.

Gnu Lesser General Public License

Version 3, 29 June 2007

Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.

0.
Additional Definitions.

As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.

“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.

An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.

A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.

The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.

The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:

a.
under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
b.
under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
3.
Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:

a.
Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
b.
Accompany the object code with a copy of the GNU GPL and this license document.
4.
Combined Works.

You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:

a.
Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
b.
Accompany the Combined Work with a copy of the GNU GPL and this license document.
c.
For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
d.
Do one of the following:
0.
Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
1.
Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
e.
Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
5.
Combined Libraries.

You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:

a.
Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
b.
Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
6.
Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

Indices and tables

·
genindex
·
modindex
·
search

Author

George Yunaev

Info

May 09, 2014 1.7 Libircclient