Package beepy :: Package profiles :: Module reverbprofile :: Class ReverbProfile
[show private | hide private]
[frames | no frames]

Class ReverbProfile

Profile --+
          |
         ReverbProfile


Method Summary
  __init__(self, session, profileInit, init_callback)
Create a new Profile object.
  parseMSG(self, msg)
parseMSG grabs the MSG payload and works out what to do
  processMessage(self, msg)
processMessage() is called by the Channel to which this profile is bound.
  requestReverb(self, number, delay, content)
Ask the remote end to reverb back to me
  sendReverb(self, msgno)
Send the reverb for the given msgno.
    Inherited from Profile
  mimeDecode(self, payload)
mimeDecode() is a convenience function used to help make life easier for profile programmers, like me.
  mimeEncode(self, payload, contentType, encoding)
mimeEncode() is a convenience function used to help make life easier for profile programmers, like me.
  setChannel(self, channel)
setChannel() binds this Profile to the Channel it belongs to.

Method Details

__init__(self, session, profileInit=None, init_callback=None)
(Constructor)

Create a new Profile object.
Parameters:
session - the session to which this profile's channel belongs.
           (type=a beepy.core.session.Session object)
profileInit - initialisation data passed to the profile
           (type=bytestring)
init_callback - a method that will do further, more complex, profile initialisation at create time.
           (type=a bound method)
Overrides:
beepy.profiles.profile.Profile.__init__ (inherited documentation)

parseMSG(self, msg)

parseMSG grabs the MSG payload and works out what to do

processMessage(self, msg)

processMessage() is called by the Channel to which this profile is bound. This forms the main processing method of a profile.

This method should be overridden by subclasses.
Parameters:
msg - the Message to process
           (type=a Message object)
Overrides:
beepy.profiles.profile.Profile.processMessage (inherited documentation)

requestReverb(self, number, delay, content)

Ask the remote end to reverb back to me

sendReverb(self, msgno)

Send the reverb for the given msgno.

Generated by Epydoc 2.0 on Thu Sep 30 14:39:25 2004 http://epydoc.sf.net