3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 20:22:45 +01:00
PyLink/docs/technical/autogen/coreplugin.html
2016-05-27 22:39:40 -07:00

77 lines
6.5 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module coreplugin</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>coreplugin</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/gl/pylink/coreplugin.py">/home/gl/pylink/coreplugin.py</a></font></td></tr></table>
<p><tt>coreplugin.py&nbsp;-&nbsp;Implements&nbsp;core&nbsp;PyLink&nbsp;functions&nbsp;as&nbsp;a&nbsp;plugin.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="classes.html">classes</a><br>
<a href="conf.html">conf</a><br>
</td><td width="25%" valign=top><a href="gc.html">gc</a><br>
<a href="os.html">os</a><br>
</td><td width="25%" valign=top><a href="signal.html">signal</a><br>
<a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="utils.html">utils</a><br>
<a href="world.html">world</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-handle_commands"><strong>handle_commands</strong></a>(irc, source, command, args)</dt><dd><tt>Handle&nbsp;commands&nbsp;sent&nbsp;to&nbsp;the&nbsp;PyLink&nbsp;service&nbsp;bots&nbsp;(PRIVMSG).</tt></dd></dl>
<dl><dt><a name="-handle_disconnect"><strong>handle_disconnect</strong></a>(irc, source, command, args)</dt><dd><tt>Handles&nbsp;network&nbsp;disconnections.</tt></dd></dl>
<dl><dt><a name="-handle_endburst"><strong>handle_endburst</strong></a>(irc, source, command, args)</dt><dd><tt>Handles&nbsp;network&nbsp;bursts.</tt></dd></dl>
<dl><dt><a name="-handle_kick"><strong>handle_kick</strong></a>(irc, source, command, args)</dt><dd><tt>Handle&nbsp;KICKs&nbsp;to&nbsp;the&nbsp;PyLink&nbsp;service&nbsp;bots,&nbsp;rejoining&nbsp;channels&nbsp;as&nbsp;needed.</tt></dd></dl>
<dl><dt><a name="-handle_kill"><strong>handle_kill</strong></a>(irc, source, command, args)</dt><dd><tt>Handle&nbsp;KILLs&nbsp;to&nbsp;PyLink&nbsp;service&nbsp;bots,&nbsp;respawning&nbsp;them&nbsp;as&nbsp;needed.</tt></dd></dl>
<dl><dt><a name="-handle_mode"><strong>handle_mode</strong></a>(irc, source, command, args)</dt><dd><tt>Protect&nbsp;against&nbsp;forced&nbsp;deoper&nbsp;attempts.</tt></dd></dl>
<dl><dt><a name="-handle_operup"><strong>handle_operup</strong></a>(irc, source, command, args)</dt><dd><tt>Logs&nbsp;successful&nbsp;oper-ups&nbsp;on&nbsp;networks.</tt></dd></dl>
<dl><dt><a name="-handle_services_login"><strong>handle_services_login</strong></a>(irc, source, command, args)</dt><dd><tt>Sets&nbsp;services&nbsp;login&nbsp;status&nbsp;for&nbsp;users.</tt></dd></dl>
<dl><dt><a name="-handle_version"><strong>handle_version</strong></a>(irc, source, command, args)</dt><dd><tt>Handles&nbsp;requests&nbsp;for&nbsp;the&nbsp;PyLink&nbsp;server&nbsp;version.</tt></dd></dl>
<dl><dt><a name="-handle_whois"><strong>handle_whois</strong></a>(irc, source, command, args)</dt><dd><tt>Handle&nbsp;WHOIS&nbsp;queries,&nbsp;for&nbsp;IRCds&nbsp;that&nbsp;send&nbsp;them&nbsp;across&nbsp;servers&nbsp;(charybdis,&nbsp;UnrealIRCd;&nbsp;NOT&nbsp;InspIRCd).</tt></dd></dl>
<dl><dt><a name="-identify"><strong>identify</strong></a>(irc, source, args)</dt><dd><tt>&lt;username&gt;&nbsp;&lt;password&gt;<br>
&nbsp;<br>
Logs&nbsp;in&nbsp;to&nbsp;PyLink&nbsp;using&nbsp;the&nbsp;configured&nbsp;administrator&nbsp;account.</tt></dd></dl>
<dl><dt><a name="-load"><strong>load</strong></a>(irc, source, args)</dt><dd><tt>&lt;plugin&nbsp;name&gt;.<br>
&nbsp;<br>
Loads&nbsp;a&nbsp;plugin&nbsp;from&nbsp;the&nbsp;plugin&nbsp;folder.</tt></dd></dl>
<dl><dt><a name="-rehash"><strong>rehash</strong></a>(irc, source, args)</dt><dd><tt>takes&nbsp;no&nbsp;arguments.<br>
&nbsp;<br>
Reloads&nbsp;the&nbsp;configuration&nbsp;file&nbsp;for&nbsp;PyLink,&nbsp;(dis)connecting&nbsp;added/removed&nbsp;networks.<br>
Plugins&nbsp;must&nbsp;be&nbsp;manually&nbsp;reloaded.</tt></dd></dl>
<dl><dt><a name="-reload"><strong>reload</strong></a>(irc, source, args)</dt><dd><tt>&lt;plugin&nbsp;name&gt;.<br>
&nbsp;<br>
Loads&nbsp;a&nbsp;plugin&nbsp;from&nbsp;the&nbsp;plugin&nbsp;folder.</tt></dd></dl>
<dl><dt><a name="-shutdown"><strong>shutdown</strong></a>(irc, source, args)</dt><dd><tt>takes&nbsp;no&nbsp;arguments.<br>
&nbsp;<br>
Exits&nbsp;PyLink&nbsp;by&nbsp;disconnecting&nbsp;all&nbsp;networks.</tt></dd></dl>
<dl><dt><a name="-sighup_handler"><strong>sighup_handler</strong></a>(_signo, _stack_frame)</dt><dd><tt>Handles&nbsp;SIGHUP&nbsp;by&nbsp;rehashing&nbsp;the&nbsp;PyLink&nbsp;daemon.</tt></dd></dl>
<dl><dt><a name="-sigterm_handler"><strong>sigterm_handler</strong></a>(_signo, _stack_frame)</dt><dd><tt>Handles&nbsp;SIGTERM&nbsp;gracefully&nbsp;by&nbsp;shutting&nbsp;down&nbsp;the&nbsp;PyLink&nbsp;daemon.</tt></dd></dl>
<dl><dt><a name="-spawn_service"><strong>spawn_service</strong></a>(irc, source, command, args)</dt><dd><tt>Handles&nbsp;new&nbsp;service&nbsp;bot&nbsp;introductions.</tt></dd></dl>
<dl><dt><a name="-unload"><strong>unload</strong></a>(irc, source, args)</dt><dd><tt>&lt;plugin&nbsp;name&gt;.<br>
&nbsp;<br>
Unloads&nbsp;a&nbsp;currently&nbsp;loaded&nbsp;plugin.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>log</strong> = &lt;logging.RootLogger object&gt;<br>
<strong>myident</strong> = 'pylink'<br>
<strong>mynick</strong> = 'PyLink'</td></tr></table>
</body></html>