In Files

  • xmlrpc/server.rb


Implements a standalone XML-RPC server. The method #serve is left if a SIGHUP is sent to the program.

 require "xmlrpc/server"

s =

s.add_handler("michael.add") do |a,b|
  a + b

s.add_handler("michael.div") do |a,b|
  if b == 0
    raise, "division by zero")
    a / b

s.set_default_handler do |name, *args|
  raise, "Method #{name} missing" +
                                   " or wrong number of parameters!")


Public Class Methods

new(port=8080, host="", maxConnections=4, stdlog=$stdout, audit=true, debug=true, *a) click to toggle source

Creates a new XMLRPC::Server instance, which is a XML-RPC server listening on the given port and accepts requests for the given host, which is localhost by default.

The server is not started, to start it you have to call #serve.

The optional audit and debug parameters are obsolete!

All additionally provided parameters in *a are by-passed to

               # File xmlrpc/server.rb, line 575
def initialize(port=8080, host="", maxConnections=4, stdlog=$stdout, audit=true, debug=true, *a)
  require 'webrick'
  @server = => port, :BindAddress => host, :MaxClients => maxConnections,
                                    :Logger =>
  @server.mount("/", self)

Public Instance Methods

serve() click to toggle source

Call this after you have added all you handlers to the server. This method starts the server to listen for XML-RPC requests and answer them.

               # File xmlrpc/server.rb, line 585
def serve
  signals = %w[INT TERM HUP] & Signal.list.keys
  signals.each { |signal| trap(signal) { @server.shutdown } }

shutdown() click to toggle source

Stops and shuts the server down.

               # File xmlrpc/server.rb, line 593
def shutdown

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit