XML-RPC Reference

These XML-RPC functions are called by the front method call()

publiforge.views.xmlrpc.agent_id(request, context)[source]

Return the unique ID of an agent.

Parameters:
Returns:

(tuple) (error, uid)
publiforge.views.xmlrpc.processor_list(request, context)[source]

Return a list of available processors.

Parameters:
Returns:

(tuple) (error, processor_list)
publiforge.views.xmlrpc.processor_xml(request, context, processor_id)[source]

Return XML of processor processor_id.

Parameters:
Returns:

(tuple) (<error>, <processor_list>)
publiforge.views.xmlrpc.activity(request, context)[source]

Return the agent activity i.e. the number of active builds.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • password – (string) Front password to use agent services.
Returns:

(tuple) (<error>, <activity>)
publiforge.views.xmlrpc.synchronizing(request, context, build_id, lock=True)[source]

The data synchronization for the build build_id is running.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • build_id – (string) Build ID.
  • lock – (boolean, default=True) If True try to add build build_id in the list of synchronizations.
Returns:

(tuple) (<error>, '')
publiforge.views.xmlrpc.start(request, context, build_id, processing, pack, end_url)[source]

Start the build.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • build_id – (string) Build ID.
  • processing – (dictionary) A processing dictionary.
  • pack – (dictionary) A pack dictionary.
  • end_url – (string) URL to call to complete the build.
Returns:

(tuple) (<error>, '')

Arguments of this RPC function are: <front_id>, <password>, <user>, <build_id>, <processing>, <pack>, <end_url>.

publiforge.views.xmlrpc.progress(request, context, build_id)[source]

Return the progress of a build.

Parameters:
Returns:

(tuple) (<error>, <result>)
publiforge.views.xmlrpc.stop(request, context, build_id)[source]

Stop a build.

Parameters:
Returns:

(tuple) (<error>, <result>)
publiforge.views.xmlrpc.result(request, context, build_id)[source]

Return the result of a build.

Parameters:
publiforge.views.xmlrpc.buildspace_cleanup(request, context, root, filenames)[source]

Delete files in path path of buildspace directory which are not in files.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • root – (string) Path to clean up.
  • filenames – (list) Names of file to keep.
Returns:

(tuple) (<error>, '')
publiforge.views.xmlrpc.buildspace_send_signature(request, context, filename)[source]

Return signature of a buildspace file.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • filename – (string) Filename that should send the signature.
Returns:

(tuple) (<error>, <signature>)
publiforge.views.xmlrpc.buildspace_receive_delta(request, context, filename, delta)[source]

Receive a delta (rsync) for a file in buildspace directory.

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • filename – (string) Filename that should send the signature.
  • delta – (xmlrpclib.Binary instance) Patch to apply.
Returns:

(tuple) (<error>, '')
publiforge.views.xmlrpc.output_list(request, context, build_id)[source]

List output files of a build.

Parameters:
Returns:

(tuple) (<error>, <file_list>)
publiforge.views.xmlrpc.output_send_delta(request, context, build_id, filename, sig)[source]

Send a delta list of a file of the Output directory..

Parameters:
  • request – (pyramid.request.Request instance) Current request.
  • context – (dictionary) See call().
  • build_id – (string) Build ID.
  • filename – (string) Name of the file to transfer.
  • sig – (xmlrpclib.Binary instance) File signature.
Returns:

(tuple) (<error>, <delta>)