Package xmpp :: Module commands :: Class TestCommand
[show private | hide private]
[frames | no frames]

Class TestCommand

               PlugIn --+    
                        |    
Command_Handler_Prototype --+
                            |
                           TestCommand


Example class. You should read source if you wish to understate how it works. Generally, it presents a "master" that giudes user through to calculate something.
Method Summary
  __init__(self)
Init internal constants.
  cmdCancel(self, conn, request)
  cmdFirstStage(self, conn, request)
Determine
  cmdSecondStage(self, conn, request)
  cmdSecondStageReply(self, conn, request)
  cmdThirdStage(self, conn, request)
    Inherited from Command_Handler_Prototype
  Execute(self, conn, request)
The method that handles all the commands, and routes them to the correct method for that stage.
  getSessionID(self)
Returns an id for the command session
  plugin(self, owner, jid)
Plug command into the commands class
  plugout(self, jid)
Remove command from the commands class
  _DiscoHandler(self, conn, request, type)
The handler for discovery events
    Inherited from PlugIn
  DEBUG(self, text, severity)
Feed a provided debug line to main instance's debug facility along with our ID string.
  PlugIn(self, owner)
Attach to main instance and register ourself and all our staff in it.
  PlugOut(self)
Unregister all our staff from main instance and detach from it.

Class Variable Summary
str description = 'a noddy example command'
str name = 'testcommand'
    Inherited from Command_Handler_Prototype
list discofeatures = ['http://jabber.org/protocol/commands', ...

Method Details

__init__(self)
(Constructor)

Init internal constants.
Overrides:
xmpp.commands.Command_Handler_Prototype.__init__

cmdFirstStage(self, conn, request)

Determine

Class Variable Details

description

Type:
str
Value:
'a noddy example command'                                              

name

Type:
str
Value:
'testcommand'                                                          

Generated by Epydoc 2.1 on Wed May 4 07:28:29 2005 http://epydoc.sf.net