home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 June / ENTER.ISO / files / xampp-win32-1.4.5-installer.exe / xampp / DOCUMENTATION < prev    next >
Encoding:
Text File  |  2004-03-24  |  2.6 KB  |  88 lines
  1. /**
  2.  * $Id: DOCUMENTATION,v 1.4.2.1 2003/07/22 17:50:44 meebey Exp $
  3.  * $Revision: 1.4.2.1 $
  4.  * $Author: meebey $
  5.  * $Date: 2003/07/22 17:50:44 $
  6.  *
  7.  * Copyright (c) 2002-2003 Mirco "MEEBEY" Bauer <mail@meebey.net> <http://www.meebey.net>
  8.  * 
  9.  * Full LGPL License: <http://www.meebey.net/lgpl.txt>
  10.  * 
  11.  * This library is free software; you can redistribute it and/or
  12.  * modify it under the terms of the GNU Lesser General Public
  13.  * License as published by the Free Software Foundation; either
  14.  * version 2.1 of the License, or (at your option) any later version.
  15.  *
  16.  * This library is distributed in the hope that it will be useful,
  17.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19.  * Lesser General Public License for more details.
  20.  *
  21.  * You should have received a copy of the GNU Lesser General Public
  22.  * License along with this library; if not, write to the Free Software
  23.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24.  */
  25.  
  26. API Documention of SmartIRC
  27. -------------------------------
  28.  
  29. Contents:
  30. - Message Types
  31. - Debug Levels
  32.  
  33.  
  34. Message Types:
  35. --------------
  36. For RegisterActionhandler() and message() you pass a message type.
  37. The IRC protocol defines different kinds of messages. I don't cover all of them because
  38. there are just too many of them.
  39. RegisterActionhandler() uses bitwise constats, eg. SMARTIRC_TYPE_QUERY|SMARTIRC_TYPE_NOTICE would match
  40. if the message is SMARTIRC_TYPE_QUERY _or_ SMARTIRC_TYPE_NOTICE.
  41. SmartIRC supports currently the following message types:
  42. SMARTIRC_TYPE_UNKNOWN
  43. SMARTIRC_TYPE_CHANNEL
  44. SMARTIRC_TYPE_QUERY
  45. SMARTIRC_TYPE_CTCP
  46. SMARTIRC_TYPE_NOTICE
  47. SMARTIRC_TYPE_WHO
  48. SMARTIRC_TYPE_JOIN
  49. SMARTIRC_TYPE_INVITE
  50. SMARTIRC_TYPE_ACTION
  51. SMARTIRC_TYPE_TOPICCHANGE
  52. SMARTIRC_TYPE_NICKCHANGE
  53. SMARTIRC_TYPE_KICK
  54. SMARTIRC_TYPE_QUIT
  55. SMARTIRC_TYPE_LOGIN
  56. SMARTIRC_TYPE_INFO
  57. SMARTIRC_TYPE_LIST
  58. SMARTIRC_TYPE_NAME
  59. SMARTIRC_TYPE_MOTD
  60. SMARTIRC_TYPE_MODECHANGE
  61. SMARTIRC_TYPE_PART
  62. SMARTIRC_TYPE_ERROR
  63. SMARTIRC_TYPE_BANLIST
  64. SMARTIRC_TYPE_TOPIC
  65. SMARTIRC_TYPE_NONRELEVANT
  66. SMARTIRC_TYPE_WHOIS
  67. SMARTIRC_TYPE_WHOWAS
  68. SMARTIRC_TYPE_USERMODE
  69. SMARTIRC_TYPE_CHANNELMODE
  70. SMARTIRC_TYPE_CTCP_REQUEST
  71. SMARTIRC_TYPE_CTCP_REPLY
  72.  
  73. Debug Levels:
  74. ------------
  75. Here the list of avialable debug levels, used for the setDebug() setting and log() method:
  76. SMARTIRC_DEBUG_NONE
  77. SMARTIRC_DEBUG_NOTICE
  78. SMARTIRC_DEBUG_CONNECTION
  79. SMARTIRC_DEBUG_SOCKET
  80. SMARTIRC_DEBUG_IRCMESSAGES
  81. SMARTIRC_DEBUG_MESSAGETYPES
  82. SMARTIRC_DEBUG_ACTIONHANDLER
  83. SMARTIRC_DEBUG_TIMEHANDLER
  84. SMARTIRC_DEBUG_MESSAGEHANDLER
  85. SMARTIRC_DEBUG_CHANNELSYNCING
  86. SMARTIRC_DEBUG_MESSAGEPARSER
  87. SMARTIRC_DEBUG_ALL
  88.