Yapircl

Bot

Yapircl
  |
  +-- YapirclBot
    |
    +-- Bot

private class Bot extends YapirclBot

An instance of this class can connect to one IRC server and register the user on the server. It will transparently stay connected, answer serverpings and queue the commands you send as long as you call the idle() method to update the state of the Yapircl object. The class is used by sub-classing it and adding event_* callback functions to your own class. Several of the most regular messages are parsed into pieces you can use within your callbacks.

Authors	Geir Torstein Kristiansen <gtk@techie.online.no>
Version	0.5.8

Methods inherited from YapirclBot

yapirclbot, setserverlist, _tryserver, loopserverlist, secondstohuman, getuptimetotal, getuptimeconnected, bytestokb, getrxtotal, gettxtotal, getrxconnected, gettxconnected, botcommanduptime, botcommandnetuse

Methods inherited from Yapircl

yapircl, getversion, debug, stimer, stimercheck, setdebug, setdebugext, setqpri, setuseq, setpass, setuser, setserver, setlocalip, setlocalhost, setctcpversion, pass, nick, user, oper, quit, join, who, part, mode, topic, invite, kick, privmsg, notice, action, ctcp, chanlist, _checkflood, ctcpreply, pong, sendnow, send, _addqueuetimer, _queuetosendbuffer, _commitsendbuffer, _ircsend, _ircrecv, _event_ping, _numeventtonamed, _trycallback, _msgparser, _putmsgparts, _msgtype, _tocallback, _select, addtimer, _runtimer, idle, _sockerror, _sockopen, _sockdie, _event_rpl_welcome, _senduserdata, _event_err_nicknameinuse, _reguser, _event_rpl_isupport, _addnick, _delnickone, _delnickall, _event_rpl_namreply, _event_join, _event_rpl_whoreply, _event_rpl_endofwho, _event_part, _event_kick, _event_quit, _event_kill, _event_nick, _trymodecallbacks, _modeparser, _event_mode, _event_rpl_channelmodeis, _event_chanmode_set_v, _event_chanmode_unset_v, _event_chanmode_set_o, _event_chanmode_unset_o, getnicklist, getchannels, ischannel, getchanneltotalusers, getchanneltotalvoices, getchanneltotalops, isnick, isop, isvoice, _event_rpl_topic, _event_topic, _event_rpl_topicwhotime, _event_rpl_creationtime, _handlectcpping, _handlectcpversion, _event_public_ctcp_ping, _event_public_ctcp_version, _event_private_ctcp_ping, _event_private_ctcp_version, run, _checktimeout, connect, connected

Public Method Summary
void	Bot() Warning: documentation is missing.

Private Method Summary
void	event_connect() Warning: documentation is missing.
void	handleBotCommands() Warning: documentation is missing.
void	event_public_privmsg() Warning: documentation is missing.
void	event_private_privmsg() Warning: documentation is missing.

Fields inherited from YapirclBot

$_serverlist, $yaprefs_wait_retry_con, $yaprefs_retry_delta_con, $yaprefs_try_each_con, $yaprefs_server_ok_con, $_connections, $_server_current, $_server_retries, $_server_delta

Fields inherited from Yapircl

$_debug, $_debugext, $_server_password, $_name, $_wantnick, $usednick, $_nickoff, $_realname, $_mode, $server, $port, $_localip, $connected, $registered, $_ircfp, $_fline, $_fline_strlen, $_xline, $_xline_sizeof, $_totlines_rx, $_totlines_tx, $_totbytes_rx, $_totbytes_tx, $_conlines_rx, $_conlines_tx, $_conbytes_rx, $_conbytes_tx, $_tstamp_rx, $_tstamp_tx, $_uptime_total, $_uptime_connected, $_qpri, $_useq, $_queue_nor, $_queue_pri, $_queue_nextsend, $_sendbuffer, $_qtlock, $_timers, $uname, $yaprefs_wait_reg, $yaprefs_idlesleep, $yaprefs_wait_con, $yaprefs_rxtimeout, $yaprefs_txtimeout, $yaprefs_ctcpver, $serverinfo, $channels, $usermode, $prefix, $command, $parnum, $params, $trailing, $nick, $user, $host, $from, $word, $rest, $full, $modearg

Public Method Details
Bot
public void Bot()
	Warning: documentation is missing.
Returns	void

Private Method Details
event_connect
private void event_connect()
	Warning: documentation is missing.
Returns	void

handleBotCommands
private void handleBotCommands()
	Warning: documentation is missing.
Returns	void

event_public_privmsg
private void event_public_privmsg()
	Warning: documentation is missing.
Returns	void

event_private_privmsg
private void event_private_privmsg()
	Warning: documentation is missing.
Returns	void