NAME

ircServer

DESCRIPTION

This module is a helper for the zebot project, it represents the link to exactly one server, which can in retrun handle several channel connections.

it has only minimal signal support, using objects are thought to register themselves as listeners for this object and process themselves the incoming data

COPYRIGHT and LICENCE

  zebot::ircServer is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; version 2
  of the License.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

Methods of this class

new

constructor for the new irc-server handler object

init

prepare a connection with the ircserver

_start

start up operation concerning this irc server

_stop

shut down operation concerning this irc server

irc_disconnected

Reconnect to the server when we die.

network_connected

connection to a server achieved

After we successfully log into the IRC server, join a channel.

version

return the version of this module

doConnect

do the actual job of connecting to the server

irc_socketerr

failed to make the connection to the server

irc_connected

we got a socket open with the server! first success!

channel_namelist

we received a end of names list, means we are newly connected

irc_kick

react on some user or the bot itself beeing kicked

rejoin

bot was kicked probably.... try to rejoin the channel

channel_join_success

we managed to join the channel

irc_ping

monitor the ping request, if they come to miss our own session will catch it and try to send somethgn to the server to force either a response our an acknowledgment that the connection is down

keep_connected

monitor the ping request, if they come to miss our own session will catch it and try to send somethgn to the server to force either a response our an acknowledgment that the connection is down, this supposes that at least once the sampling of the working server was made

setting

setter/getter for the settings, to be able to choose any format for those settings without disturbing the rest of the program...

irc_invite

someone invited us, be so nice as to join their channel

irc_public

react on a line send to the actual chan

irc_quit

react on some user dropping out of the channel

irc_part

react on some user leaving the channel

irc_mode

react on mode change issued by someone

irc_join

react on some user joining the channel

irc_msg

react on private msg send directly to the bot

irc_notice

react on notice send to the actual chan

irc_ctcp_ping

react to a ping request

irc_ctcpreply_ping

Gives lag results for outgoing PINGs.

irc_ctcp_action

react on private msg send directly to the bet

irc_ctcp_version

spit out the version num and info when asked through ctcp version

channel_join_topic

we received a channel topic

irc_dcc_done

react on some dcc transfer success

irc_dcc_error

react on some dcc transfer fail

irc_dcc_request

react on some dcc transfer/chat proposal

 You receive this event when another IRC client sends you a DCC SEND
 or CHAT request out of the blue. You can examine the request and
 decide whether or not to accept it here. ARG0 is the nick of the
 client on the other end. ARG1 is the type of DCC request (CHAT,
 SEND, etc.). ARG2 is the port number. ARG3 is a "magic cookie"
 argument, suitable for sending with 'dcc_accept' events to signify
 that you want to accept the connection (see the 'dcc_accept' docs).
 For DCC SEND and GET connections, ARG4 will be the filename, and
 ARG5 will be the file size.

irc_dcc_get

data was trasnmitted successfully

 Notifies you that another block of data has been successfully
 transferred from the client on the other end of your DCC GET con-
 nection.  ARG0 is the connection's magic cookie, ARG1 is the nick
 of the person on the other end, ARG2 is the port number, ARG3 is
 the filename, ARG4 is the total file size, and ARG5 is the number
 of bytes successfully transferred so far.

irc_dcc_chat

Notifies you that one line of text has been received from the client on the other end of a DCC CHAT connection. ARG0 is the con- nection's magic cookie, ARG1 is the nick of the person on the other end, ARG2 is the port number, and ARG3 is the text they sent.

irc_nick_taken

 nick allready taken, create a new one
 TODO add here the nickserv handler!!!

AUTHOR

Bruno Böttcher <bboett at adlp.org>

NAME

DESCRIPTION

COPYRIGHT and LICENCE

Methods of this class

AUTHOR

SEE ALSO