Package svs_core :: Package network :: Module clientuser
[show private | hide private]
[frames | no frames]

Module svs_core.network.clientuser

This is the module from which classes and methods implemented by a remote
client are derived.

It uses the twisted framework: U{http://twistedmatrix.com}.  For more information
relating the clients see the documentation on twisted's Perspective Broker system:
U{http://twistedmatrix.com/documents/howto}.

@author:        Simon Yuill
@copyright:     2005 Simon Yuill
@license:       GNU GPL version 2 or any later version
@contact:       simon@lipparosa.org

TO DO:

- add multicast for zero-conf and heartbeat
- service browsing functionality
- adverts
- media retrieval (P2P, HTTP)
- descriptor classes for services

Classes
ClientProfile Holds information about a client, used to advertise its functionality.
GenericClient GenericClient provides the basic client capabilities for SVS clients.
GraphicalClient SVS client with graphical interface.
ScriptableClient Scriptable SVS client.

Exceptions
ClientException  

Function Summary
  addRemoteMethodsToProfile(obj)
Checks if methods for specified object can be called remotely, and adds them to profile if so.
  __remote_callable(obj, methodName)
Checks if method for specified object is callable, and then if it conforms to the twisted remote call signature, ie.
  __stripTwistedSignature(methodName)
Removes all characters from the specified method name up to, and including, the first '_', returning shortened string or None.

Function Details

addRemoteMethodsToProfile(obj)

Checks if methods for specified object can be called remotely, and adds them to profile if so.

__remote_callable(obj, methodName)

Checks if method for specified object is callable, and then if it conforms to the twisted remote call signature, ie. begins with 'remote_' or 'perspective_'
Returns:
string

__stripTwistedSignature(methodName)

Removes all characters from the specified method name up to, and including, the first '_', returning shortened string or None.
Returns:
string

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