niryo_libraries.rosgraph.xmlrpc.XmlRpcNode

class documentation

class XmlRpcNode(object):

Constructor: XmlRpcNode(port, rpc_handler, on_run_error)

View In Hierarchy

Generic XML-RPC node. Handles the additional complexity of binding an XML-RPC server to an arbitrary port. XmlRpcNode is initialized when the uri field has a value.

Method __init__ XML RPC Node constructor :param port: port to use for starting XML-RPC API. Set to 0 or omit to bind to any available port, int :param rpc_handler: XML-RPC API handler for node, XmlRpcHandler :param on_run_error: function to invoke if server...
Method run Undocumented
Method set_uri Sets the XML-RPC URI. Defined as a separate method as a hood for subclasses to bootstrap initialization. Should not be called externally.
Method shutdown Terminate i/o connections for this server.
Method start Initiate a thread to run the XML RPC server. Uses thread.start_new_thread.
Instance Variable handler Undocumented
Instance Variable is_shutdown Undocumented
Instance Variable on_run_error Undocumented
Instance Variable port Undocumented
Instance Variable server Undocumented
Instance Variable uri Undocumented
Method _run Main processing thread body. :raises: socket.error If server cannot bind
Method _run_init Undocumented
def __init__(self, port=0, rpc_handler=None, on_run_error=None):

XML RPC Node constructor :param port: port to use for starting XML-RPC API. Set to 0 or omit to bind to any available port, int :param rpc_handler: XML-RPC API handler for node, XmlRpcHandler :param on_run_error: function to invoke if server.run() throws

Exception. Server always terminates if run() throws, but this enables cleanup routines to be invoked if server goes down, as well as include additional debugging. fn(Exception)
def run(self):

Undocumented

def set_uri(self, uri):

Sets the XML-RPC URI. Defined as a separate method as a hood for subclasses to bootstrap initialization. Should not be called externally.

Parameters
uriXMLRPC URI, str
def shutdown(self, reason):

Terminate i/o connections for this server.

Parameters
reasonhuman-readable debug string, str
def start(self):

Initiate a thread to run the XML RPC server. Uses thread.start_new_thread.

handler =

Undocumented

is_shutdown: bool =

Undocumented

on_run_error =

Undocumented

port =

Undocumented

server =

Undocumented

uri =

Undocumented

def _run(self):

Main processing thread body. :raises: socket.error If server cannot bind

def _run_init(self):

Undocumented