- Publicity: Public Only All
xml-rpc-procs.tcl
Initially created by Dave Bauer 2001-03-30 with inspiration from Steve Ball and help from Aaron Swartz and Jerry Asher.
Modified by Vinod Kurup to
- Use the xml abstraction procs in packages/acs-tcl/tcl/30-xml-utils-procs.tcl (which use tDom now)
- Fit in OpenACS 5 framework
- Location:
- packages/xml-rpc/tcl/xml-rpc-procs.tcl
- Created:
- 2003-09-30
- Author:
- Vinod Kurup [vinod@kurup.com]
- CVS Identification:
$Id: xml-rpc-procs.tcl,v 1.20 2024/09/11 06:15:55 gustafn Exp $
Procedures in this file
- xmlrpc::enabled_p (public)
- xmlrpc::list_methods (public)
- xmlrpc::register_proc (public)
- xmlrpc::remote_call (public)
- xmlrpc::url (public)
Detailed information
xmlrpc::enabled_p (public)
xmlrpc::enabled_p
- Returns:
- whether the server is enabled
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xmlrpc::list_methods (public)
xmlrpc::list_methods
- Returns:
- alphabetical list of XML-RPC procs on this server
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xmlrpc::register_proc (public)
xmlrpc::register_proc proc_name
Register a proc to be available via XML-RPC.
proc_nameis the name of a proc that is defined in the usual OpenACS way (i.e. ad_proc). Theproc_nameis added to the xmlrpc_procs nsv array with a value of 1. When an XML-RPC call comes in, this array is searched to see if the proc_name has been registered. Currently, the presence ofproc_namein the nsv is enough to indicate that the proc can be called via XML-RPC. At some point we may allow administrators to disable procs, so we could set the value associated withproc_namefrom 1 to 0.
- Parameters:
- proc_name (required)
- Name of proc to be registered.
- Returns:
- nothing
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xmlrpc::remote_call (public)
xmlrpc::remote_call url method [ args ]
Invoke a method on a remote server using XML-RPC
- Parameters:
- url (required)
- url of service
- method (required)
- method to call
- args (optional)
- list of args to the method
- Returns:
- the response of the remote service. Error if remote service returns a fault.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
xmlrpc::url (public)
xmlrpc::url
- Returns:
- the URL that is listening for RPC requests
- Author:
- Vinod Kurup
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- xml_rpc_validate
