BigBrotherBot v1.9.0
System Development Information for the BigBrotherBot project.

b3::plugins::publist::PublistPlugin Class Reference

Inheritance diagram for b3::plugins::publist::PublistPlugin:
b3::plugin::Plugin b3::plugin::Plugin

List of all members.

Public Member Functions

def onLoadConfig
def onStartup
def onEvent
def removeCrontab
def shutdown
def update
def sendInfo
def sendInfoToMaster
def onLoadConfig
def onStartup
def onEvent
def removeCrontab
def shutdown
def update
def sendInfo
def sendInfoToMaster

Static Public Attributes

 requiresConfigFile = False

Private Attributes

 _initial_heartbeat_delay_minutes
 _adminPlugin

Static Private Attributes

 _cronTab = None
string _url = 'http://www.bigbrotherbot.net/master/serverping.php'
 _secondUrl = None
 _heartbeat_sent = False
int _initial_heartbeat_delay_minutes = 5

Member Function Documentation

def b3::plugins::publist::PublistPlugin::onEvent (   self,
  event 
)
\
Called by B3 when a registered event is encountered. You must overwrite
this to intercept events.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::onEvent (   self,
  event 
)
\
Called by B3 when a registered event is encountered. You must overwrite
this to intercept events.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::onLoadConfig (   self)
\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::onLoadConfig (   self)
\
This is called after loadConfig(). Any plugin private variables loaded
from the config need to be reset here.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::onStartup (   self)
\
Called after the plugin is created before it is started. Overwrite this
for anything you need to initialize you plugin with.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::onStartup (   self)
\
Called after the plugin is created before it is started. Overwrite this
for anything you need to initialize you plugin with.

Reimplemented from b3::plugin::Plugin.

def b3::plugins::publist::PublistPlugin::removeCrontab (   self)
def b3::plugins::publist::PublistPlugin::removeCrontab (   self)
def b3::plugins::publist::PublistPlugin::sendInfo (   self,
  info = {} 
)
def b3::plugins::publist::PublistPlugin::sendInfo (   self,
  info = {} 
)
def b3::plugins::publist::PublistPlugin::sendInfoToMaster (   self,
  url,
  info = {} 
)
def b3::plugins::publist::PublistPlugin::sendInfoToMaster (   self,
  url,
  info = {} 
)
def b3::plugins::publist::PublistPlugin::shutdown (   self)
Send a shutdown heartbeat to B3 master server
def b3::plugins::publist::PublistPlugin::shutdown (   self)
Send a shutdown heartbeat to B3 master server
def b3::plugins::publist::PublistPlugin::update (   self)
send an upate heartbeat to B3 master server
def b3::plugins::publist::PublistPlugin::update (   self)
send an upate heartbeat to B3 master server

Member Data Documentation

string b3::plugins::publist::PublistPlugin::_url = 'http://www.bigbrotherbot.net/master/serverping.php' [static, private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Properties