Packageindex Classtrees Modulegroups Elementlist Report XML Files

Yapircl

YapirclBot

Yapircl
  |
  +-- YapirclBot

private class YapirclBot extends Yapircl

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
 
Direct known subclasses: Bot

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 YapirclBot()
Warning: documentation is missing.

Private Method Summary

void setServerList( $serverlist)
Warning: documentation is missing.
void _tryServer()
Warning: documentation is missing.
void loopServerList( $mainloop_method)
Warning: documentation is missing.
void secondsToHuman( $totalseconds)
Warning: documentation is missing.
void getUptimeTotal()
Warning: documentation is missing.
void getUptimeConnected()
Warning: documentation is missing.
void bytesToKb( $bytes)
Warning: documentation is missing.
void getRxTotal()
Warning: documentation is missing.
void getTxTotal()
Warning: documentation is missing.
void getRxConnected()
Warning: documentation is missing.
void getTxConnected()
Warning: documentation is missing.
void botCommandUptime()
Warning: documentation is missing.
void botCommandNetuse()
Warning: documentation is missing.

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

Private Field Summary

unknown $_serverlist

unknown $yaprefs_wait_retry_con

unknown $yaprefs_retry_delta_con

unknown $yaprefs_try_each_con

unknown $yaprefs_server_ok_con

unknown $_connections

unknown $_server_current

unknown $_server_retries

unknown $_server_delta

Public Method Details

YapirclBot

public void YapirclBot()

 

Warning: documentation is missing.

Returns void


Private Method Details

setServerList

private void setServerList( $serverlist)

 

Warning: documentation is missing.

Parameter
$serverlist
Warning: documentation is missing.
Returns void


_tryServer

private void _tryServer()

 

Warning: documentation is missing.

Returns void


loopServerList

private void loopServerList( $mainloop_method)

 

Warning: documentation is missing.

Parameter
$mainloop_method
Warning: documentation is missing.
Returns void


secondsToHuman

private void secondsToHuman( $totalseconds)

 

Warning: documentation is missing.

Parameter
$totalseconds
Warning: documentation is missing.
Returns void


getUptimeTotal

private void getUptimeTotal()

 

Warning: documentation is missing.

Returns void


getUptimeConnected

private void getUptimeConnected()

 

Warning: documentation is missing.

Returns void


bytesToKb

private void bytesToKb( $bytes)

 

Warning: documentation is missing.

Parameter
$bytes
Warning: documentation is missing.
Returns void


getRxTotal

private void getRxTotal()

 

Warning: documentation is missing.

Returns void


getTxTotal

private void getTxTotal()

 

Warning: documentation is missing.

Returns void


getRxConnected

private void getRxConnected()

 

Warning: documentation is missing.

Returns void


getTxConnected

private void getTxConnected()

 

Warning: documentation is missing.

Returns void


botCommandUptime

private void botCommandUptime()

 

Warning: documentation is missing.

Returns void


botCommandNetuse

private void botCommandNetuse()

 

Warning: documentation is missing.

Returns void


Private Field Details

$_serverlist

private unknown $_serverlist

>><<


$yaprefs_wait_retry_con

private unknown $yaprefs_wait_retry_con

>><<


$yaprefs_retry_delta_con

private unknown $yaprefs_retry_delta_con

>><<


$yaprefs_try_each_con

private unknown $yaprefs_try_each_con

>><<


$yaprefs_server_ok_con

private unknown $yaprefs_server_ok_con

>><<


$_connections

private unknown $_connections

>><<


$_server_current

private unknown $_server_current

>><<


$_server_retries

private unknown $_server_retries

>><<


$_server_delta

private unknown $_server_delta

>><<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Sun, 22 Dec 2002 21:16:22 +0100 by PHPDoc 0.1.0 BETA www.phpdoc.de