Package svs_core :: Package network :: Module clustermanager :: Class ClusterManager
[show private | hide private]
[frames | no frames]

Class ClusterManager


This class provides basic server functionality and client authentication.

For another kind of application class to use the server it must provide a twisted.cred.portal.IRealm instance and implement the following methods:
Method Summary
  __init__(self, port, tickDuration)
  addClientAuthentication(self, name, password)
Create authentication account for client.
  errorMessage(self, text)
Handles error messages for client.
  joinClusterGroup(self, client)
Join client proxy group within world.
  leaveClusterGroup(self, client)
Remove client from group.
  loadClientAccounts(self, path)
Loads client authentication data.
  run(self)
Sets up and starts networking facilities for cluster.
  sendCommand(self, cmd)
Send command to recipient.
  setupServices(self)
Activates services.
  statusMessage(self, text)
Handles status messages for client.
  stop(self)
Stops running server.
  tick(self)
Called by reactor as clock event to update simulation.

Method Details

addClientAuthentication(self, name, password)

Create authentication account for client.

errorMessage(self, text)

Handles error messages for client. This should be overridden by implementing classes.
Parameters:
text - message
           (type=string)

joinClusterGroup(self, client)

Join client proxy group within world.

leaveClusterGroup(self, client)

Remove client from group.

loadClientAccounts(self, path)

Loads client authentication data.

NOTE: currently not implemented.
Parameters:
path - location of account data
           (type=string)

run(self)

Sets up and starts networking facilities for cluster.

sendCommand(self, cmd)

Send command to recipient.
Parameters:
cmd - command for cleint
           (type=Command)

setupServices(self)

Activates services.

NOTE: left over from earlier version, does nothing at present but might be useful later.

statusMessage(self, text)

Handles status messages for client. This should be overridden by implementing classes.
Parameters:
text - message
           (type=string)

stop(self)

Stops running server.

tick(self)

Called by reactor as clock event to update simulation.

Generated by Epydoc 2.1 on Thu Oct 20 15:30:28 2005 http://epydoc.sf.net