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

Type ClientStub

object --+    
         |    
      Stub --+
             |
            ClientStub

provider client stub
Method Summary
int cleanUp(self)
cleans the client databas.
[ clientName1, clientName2, ... ] getAllClientNames(self)
returns the list of all registered client names
{ clientName: param: value, ... , ... } getAllClients(self)
returns the client database
{ param: value, ... } getClient(self, name)
returns data of one client
boolean hasClient(self, name)
look for client
Provider login(self, name)
client login
boolean sendMessage(self, name, message)
sends a message to the client
    Inherited from Stub
  __init__(self, rpcClient)
const.
  execute(self)
  setBatchMode(self, batchmode)
    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

cleanUp(self)

cleans the client databas. expired clients will be loged out
Returns:
number of expired clients
           (type=int)

getAllClientNames(self)

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

getAllClients(self)

returns the client database
Returns:
client data
           (type={ clientName: param: value, ... , ... })

getClient(self, name)

returns data of one client
Returns:
client data
           (type={ param: value, ... })
Raises:
ClientNotFoundError - client not found

hasClient(self, name)

look for client
Returns:
True is exists
           (type=boolean)

login(self, name)

client login
Parameters:
name - client name (has to bee unique systemwide)
Returns:
Provider object
           (type=Provider)

sendMessage(self, name, message)

sends a message to the client
Parameters:
name - client name
message - message object
           (type=object/type)
Returns:
True by success; False if a message is already stored for this client
           (type=boolean)
Raises:
ClientNotFoundError - client not found

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