Trees       Index       Help   
co2 homepage
Module registry :: Class Co2Registry
[show private | hide private]
[frames | no frames]

Class Co2Registry

Known Subclasses:
Co2RelayRegistry, Co2SatelliteRegistry
holds all xmlrpc methods, registers system methods, initializes the plugin loader, and handles all incoming calls.
Method Summary
  __init__(self, vars)
set variables, load methods, start the loader, register methods.
  __str__(self)

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help 		x_co2_get_method_help(self, param_dict)
get help (the __doc__ string) for a specific method.

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names 		x_co2_get_method_names(self, param_dict)
get the names of available methods.

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature 		x_co2_get_method_signature(self, param_dict)
get a discription of how to use a specific method.

dictionary [key: value-type (description)]: co2_author: string (server author); kernel: string (host kernel name); uptime: int (server uptime in seconds); operating_system: string (host operating system); maintainer: string (server maintainer); start_time: DateTime (server start time); sw_platform: string (co2 software platform); hw_platform: string (host hardware platform); co2_version: string (co2 version); maintainer_email: string (server maintainer email); hardware: string (host hardware); plugins: list of strings (loaded plugins); server_time: DateTime (server time); processor: string (host processor)

callable as: system.get_properties, web.get_properties 		x_sys_get_properties(self, param_dict)
get system properties.

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names 		x_sys_listMethods(self, param_dict)
get the names of available methods.

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help 		x_sys_methodHelp(self, param_dict)
get help (the __doc__ string) for a specific method.

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature 		x_sys_methodSignature(self, param_dict)
get a discription of how to use a specific method.
  x_top_call_method(self, param_dict)
'anonymized' call method.

string

callable as: ping, web.ping 		x_top_ping(self, param_dict)
answer a ping request.

param_dict

callable as: test, web.test 		x_top_test(self, param_dict)
just a test method...
  x_web_call_method(self, param_dict)
'anonymized' call method.

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help 		x_web_get_method_help(self, param_dict)
get help (the __doc__ string) for a specific method.

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names 		x_web_get_method_names(self, param_dict)
get the names of available methods.

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature 		x_web_get_method_signature(self, param_dict)
get a discription of how to use a specific method.

dictionary [key: value-type (description)]: co2_author: string (server author); kernel: string (host kernel name); uptime: int (server uptime in seconds); operating_system: string (host operating system); maintainer: string (server maintainer); start_time: DateTime (server start time); sw_platform: string (co2 software platform); hw_platform: string (host hardware platform); co2_version: string (co2 version); maintainer_email: string (server maintainer email); hardware: string (host hardware); plugins: list of strings (loaded plugins); server_time: DateTime (server time); processor: string (host processor)

callable as: system.get_properties, web.get_properties 		x_web_get_properties(self, param_dict)
get system properties.

string

callable as: ping, web.ping 		x_web_ping(self, param_dict)
answer a ping request.

param_dict

callable as: test, web.test 		x_web_test(self, param_dict)
just a test method...

Method Details

__init__(self, vars)
(Constructor)

set variables, load methods, start the loader, register methods.
Parameters:
vars - registry specific variables (from config file)
           (type=dictionary)

x_co2_get_method_help(self, param_dict)

get help (the __doc__ string) for a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: name of a method (from list returned by x_co2_get_method_names))
Returns:
a brief description of what the method does
           (type=

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help)

x_co2_get_method_names(self, param_dict={})

get the names of available methods.
Returns:
method names
           (type=

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names)

x_co2_get_method_signature(self, param_dict)

get a discription of how to use a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: (callable) name of a method)
Returns:
method signature
           (type=

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature)

x_sys_get_properties(self, param_dict={})

get system properties.
Returns:
system properties
           (type=

dictionary [key: value-type (description)]: co2_author: string (server author); kernel: string (host kernel name); uptime: int (server uptime in seconds); operating_system: string (host operating system); maintainer: string (server maintainer); start_time: DateTime (server start time); sw_platform: string (co2 software platform); hw_platform: string (host hardware platform); co2_version: string (co2 version); maintainer_email: string (server maintainer email); hardware: string (host hardware); plugins: list of strings (loaded plugins); server_time: DateTime (server time); processor: string (host processor)

callable as: system.get_properties, web.get_properties)

x_sys_listMethods(self, param_dict={})

get the names of available methods.
Returns:
method names
           (type=

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names)

x_sys_methodHelp(self, param_dict)

get help (the __doc__ string) for a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: name of a method (from list returned by x_co2_get_method_names))
Returns:
a brief description of what the method does
           (type=

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help)

x_sys_methodSignature(self, param_dict)

get a discription of how to use a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: (callable) name of a method)
Returns:
method signature
           (type=

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature)

x_top_call_method(self, param_dict)

'anonymized' call method.
Parameters:
param_dict - dictionary with members: 'method_name':'method_name', plus all arguments that method expects (signature returned by x_co2_get_method_help)
           (type=dictionary)
Returns:

whatever the called method returns

callable as: call_method, web.call_method.

x_top_ping(self, param_dict={})

answer a ping request.
Returns:
'pong'
           (type=

string

callable as: ping, web.ping)

x_top_test(self, param_dict={})

just a test method...
Parameters:
param_dict - optional argument
Returns:
the argument
           (type=

param_dict

callable as: test, web.test)

x_web_call_method(self, param_dict)

'anonymized' call method.
Parameters:
param_dict - dictionary with members: 'method_name':'method_name', plus all arguments that method expects (signature returned by x_co2_get_method_help)
           (type=dictionary)
Returns:

whatever the called method returns

callable as: call_method, web.call_method.

x_web_get_method_help(self, param_dict)

get help (the __doc__ string) for a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: name of a method (from list returned by x_co2_get_method_names))
Returns:
a brief description of what the method does
           (type=

string

callable as: co2.get_method_help, sys.methodHelp, web.get_method_help)

x_web_get_method_names(self, param_dict={})

get the names of available methods.
Returns:
method names
           (type=

list of strings

callable as: co2.co2_get_method_names, sys.listMethods, web.get_method_names)

x_web_get_method_signature(self, param_dict)

get a discription of how to use a specific method.
Parameters:
param_dict - data
           (type=dictionary, mandatory key: 'method_name', value: (callable) name of a method)
Returns:
method signature
           (type=

dictionary: 'args': list of argument names (strings), 'args_d': dictionary (key=argument name, value=argument value), 'args_v': list of variable arguments (unused in xmlrpc), 'args_kw': list of keyword arguments (unused in xmlrpc)

callable as: co2.get_method_signature, sys.methodSignature, web.get_method_signature)

x_web_get_properties(self, param_dict={})

get system properties.
Returns:
system properties
           (type=

dictionary [key: value-type (description)]: co2_author: string (server author); kernel: string (host kernel name); uptime: int (server uptime in seconds); operating_system: string (host operating system); maintainer: string (server maintainer); start_time: DateTime (server start time); sw_platform: string (co2 software platform); hw_platform: string (host hardware platform); co2_version: string (co2 version); maintainer_email: string (server maintainer email); hardware: string (host hardware); plugins: list of strings (loaded plugins); server_time: DateTime (server time); processor: string (host processor)

callable as: system.get_properties, web.get_properties)

x_web_ping(self, param_dict={})

answer a ping request.
Returns:
'pong'
           (type=

string

callable as: ping, web.ping)

x_web_test(self, param_dict={})

just a test method...
Parameters:
param_dict - optional argument
Returns:
the argument
           (type=

param_dict

callable as: test, web.test)

   Trees       Index       Help   
co2 homepage
Generated by Epydoc 1.1 on Thu Oct 16 16:37:22 2003 http://epydoc.sf.net