Home       Trees       Index       Help   
Package rpcServices :: Package services :: Module provider :: Class Provider
[show private | hide private]
[frames | no frames]

Type Provider

object --+    
         |    
      Stub --+
             |
            Provider

provider object created after the login
Method Summary
  __init__(self, baseClientStub, rpcClient, name)
constr.
[ clientName1, clientName2, ... ] getAllOtherClientNames(self)
returns the list of all registered client names except the client name of this provider object
string getName(self)
get client name of this provider object
boolean logout(self)
client logout
  sendMessage(self, name, message)
@see ClientStub.sendMessage
object/type or None visit(self, status)
client visit call.
    Inherited from Stub
  execute(self)
  setBatchMode(self, batchmode)
  _getLocalExceptionClass(self, xmlRpcFault)
map xmprpclib.Fault to local client exception
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Method Details

__init__(self, baseClientStub, rpcClient, name)
(Constructor)

constr.
Parameters:
baseClientStub - base client stub object
           (type=ClientStub)
rpcClient - rpcClientStub
           (type=client.XmlRpcClient)
name - client name
Overrides:
rpcServices.core.Stub.__init__

getAllOtherClientNames(self)

returns the list of all registered client names except the client name of this provider object
Returns:
client names
           (type=[ clientName1, clientName2, ... ])

getName(self)

get client name of this provider object
Returns:
client name
           (type=string)

logout(self)

client logout
Returns:
True if client was looged in; False if client already logged out
           (type=boolean)

sendMessage(self, name, message)

@see ClientStub.sendMessage

visit(self, status)

client visit call. the client has to call this methode within every 10 minutes to keep the login status
Parameters:
status - client status
Returns:
cleint message, or None if no message is left
           (type=object/type or None)

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Fri Jan 13 23:21:03 2006 http://epydoc.sf.net