libtbx.xmlrpc_server_example
index
/net/chevy/raid1/nat/src/cctbx_project/libtbx/xmlrpc_server_example.py

 
Modules
       
os
signal
string
sys
xmlrpclib

 
Classes
       
SimpleXMLRPCServer.SimpleXMLRPCServer(SocketServer.TCPServer, SimpleXMLRPCServer.SimpleXMLRPCDispatcher)
external_xmlrpc_server
__builtin__.object
external_xmlrpc_interface

 
class external_xmlrpc_interface(__builtin__.object)
     Methods defined here:
__getattr__(self, name)
__init__(self, program_id, auto_start=True, verbose=False)
add_module(self, module_object=None, module_path=None)
is_alive(self)
quit(self)
# XXX: this should be replaced by the proper quit function for the program
# being extended - e.g. cmd.quit() in PyMOL.
set_socket_timeout(self, timeout)
setup_modules(self)
setup_server(self)
start_server(self)
start_server_in_separate_thread(self)
timeout_func(self, *args)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class external_xmlrpc_server(SimpleXMLRPCServer.SimpleXMLRPCServer)
    
Method resolution order:
external_xmlrpc_server
SimpleXMLRPCServer.SimpleXMLRPCServer
SocketServer.TCPServer
SocketServer.BaseServer
SimpleXMLRPCServer.SimpleXMLRPCDispatcher

Methods defined here:
__init__(self, addr, cctbx_interface)

Data and other attributes inherited from SimpleXMLRPCServer.SimpleXMLRPCServer:
allow_reuse_address = True

Methods inherited from SocketServer.TCPServer:
close_request(self, request)
Called to clean up an individual request.
fileno(self)
Return socket file number.
 
Interface required by select().
get_request(self)
Get the request and client address from the socket.
 
May be overridden.
server_activate(self)
Called by constructor to activate the server.
 
May be overridden.
server_bind(self)
Called by constructor to bind the socket.
 
May be overridden.
server_close(self)
Called to clean-up the server.
 
May be overridden.
shutdown_request(self, request)
Called to shutdown and close an individual request.

Data and other attributes inherited from SocketServer.TCPServer:
address_family = 2
request_queue_size = 5
socket_type = 1

Methods inherited from SocketServer.BaseServer:
finish_request(self, request, client_address)
Finish one request by instantiating RequestHandlerClass.
handle_error(self, request, client_address)
Handle an error gracefully.  May be overridden.
 
The default is to print a traceback and continue.
handle_request(self)
Handle one request, possibly blocking.
 
Respects self.timeout.
handle_timeout(self)
Called if no new request arrives within self.timeout.
 
Overridden by ForkingMixIn.
process_request(self, request, client_address)
Call finish_request.
 
Overridden by ForkingMixIn and ThreadingMixIn.
serve_forever(self, poll_interval=0.5)
Handle one request at a time until shutdown.
 
Polls for shutdown every poll_interval seconds. Ignores
self.timeout. If you need to do periodic tasks, do them in
another thread.
shutdown(self)
Stops the serve_forever loop.
 
Blocks until the loop has finished. This must be called while
serve_forever() is running in another thread, or it will
deadlock.
verify_request(self, request, client_address)
Verify the request.  May be overridden.
 
Return True if we should proceed with this request.

Data and other attributes inherited from SocketServer.BaseServer:
timeout = None

Methods inherited from SimpleXMLRPCServer.SimpleXMLRPCDispatcher:
register_function(self, function, name=None)
Registers a function to respond to XML-RPC requests.
 
The optional name argument can be used to set a Unicode name
for the function.
register_instance(self, instance, allow_dotted_names=False)
Registers an instance to respond to XML-RPC requests.
 
Only one instance can be installed at a time.
 
If the registered instance has a _dispatch method then that
method will be called with the name of the XML-RPC method and
its parameters as a tuple
e.g. instance._dispatch('add',(2,3))
 
If the registered instance does not have a _dispatch method
then the instance will be searched to find a matching method
and, if found, will be called. Methods beginning with an '_'
are considered private and will not be called by
SimpleXMLRPCServer.
 
If a registered function matches a XML-RPC request, then it
will be called instead of the registered instance.
 
If the optional allow_dotted_names argument is true and the
instance does not have a _dispatch method, method names
containing dots are supported and resolved, as long as none of
the name segments start with an '_'.
 
    *** SECURITY WARNING: ***
 
    Enabling the allow_dotted_names options allows intruders
    to access your module's global variables and may allow
    intruders to execute arbitrary code on your machine.  Only
    use this option on a secure, closed network.
register_introspection_functions(self)
Registers the XML-RPC introspection methods in the system
namespace.
 
see http://xmlrpc.usefulinc.com/doc/reserved.html
register_multicall_functions(self)
Registers the XML-RPC multicall method in the system
namespace.
 
see http://www.xmlrpc.com/discuss/msgReader$1208
system_listMethods(self)
system.listMethods() => ['add', 'subtract', 'multiple']
 
Returns a list of the methods supported by the server.
system_methodHelp(self, method_name)
system.methodHelp('add') => "Adds two integers together"
 
Returns a string containing documentation for the specified method.
system_methodSignature(self, method_name)
system.methodSignature('add') => [double, int, int]
 
Returns a list describing the signature of the method. In the
above example, the add method takes two integers as arguments
and returns a double result.
 
This server does NOT support system.methodSignature.
system_multicall(self, call_list)
system.multicall([{'methodName': 'add', 'params': [2, 2]}, ...]) => [[4], ...]
 
Allows the caller to package multiple XML-RPC calls into a single
request.
 
See http://www.xmlrpc.com/discuss/msgReader$1208

 
Functions
       
coot_server()
test_server()

 
Data
        DEFAULT_PORT = 40000
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)