b_socket.h

   1 /*  b_socket.h - Prototypes of the sockets in the IRC bot.
   2  *  ======================================================
   3  *
   4  *  This file contains the prototypes of the function(s)
   5  *  that will be used by the bot to stablish a connection
   6  *  between the IRC server and the IRC bot.
   7  *  ======================================================
   8  *  Copyright (C) 2009  "Carlos Ríos Vera" <crosvera@gmail.com>
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  *
  24  ***********************************************************/
  25
  26 #ifndef _B_SOCKET_H
  27 #define _B_SOCKET_H
  28
  29 #include "config.h"
  30
  31 /* Other macros */
  32 //#define printlog(MSG)   printf("$BOT > %s", MSG)
  33
  34 /* The `set_socket' function will (as the name says) set the
  35  * socket which allow the comunication between the IRC server
  36  * and the bot. This function need a pointer to a
  37  * `struct _config' structure which contains the information
  38  * of the connection (such as the server, nick, and so on).
  39  * This function return an `int' value, this value is defined
  40  * in the macros (IRC_RECONNECT, ERROR_EXIT, SUCCESS_EXIT)
  41  * before in this file.
  42  ***********************************************************/
  43 int set_socket( struct _config *config );
  44
  45 #endif /* _B_SOCKET_H */