Class: XMLRPC::Server (Ruby 2.2.2)
Description: Class : XMLRPC::Server - Ruby 2.2.2

- Home
- Core 2.2.2
- Std-lib 2.2.2
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- xmlrpc/server.rb

### Parent

XMLRPC::WEBrickServlet

### Methods

- ::new
- #serve
- #shutdown

### Class/Module Index

Quicksearch

- NQXML
- NQXML::Node
- XMLRPC
- XMLRPC::Base64
- XMLRPC::BasicServer
- XMLRPC::CGIServer
- XMLRPC::Client
- XMLRPC::Client::Proxy
- XMLRPC::Config
- XMLRPC::Convert
- XMLRPC::Create
- XMLRPC::DateTime
- XMLRPC::FaultException
- XMLRPC::Marshal
- XMLRPC::Marshallable
- XMLRPC::ModRubyServer
- XMLRPC::ParseContentType
- XMLRPC::ParserWriterChooseMixin
- XMLRPC::Server
- XMLRPC::Service
- XMLRPC::Service::BasicInterface
- XMLRPC::Service::Interface
- XMLRPC::Service::PublicInstanceMethodsInterface
- XMLRPC::WEBrickServlet
- XMLRPC::XMLParser
- XMLRPC::XMLParser::AbstractStreamParser
- XMLRPC::XMLParser::AbstractTreeParser
- XMLRPC::XMLParser::LibXMLStreamParser
- XMLRPC::XMLParser::LibXMLStreamParser::LibXMLStreamListener
- XMLRPC::XMLParser::NQXMLParser
- XMLRPC::XMLParser::NQXMLStreamParser
- XMLRPC::XMLParser::NQXMLStreamParser::XMLRPCParser
- XMLRPC::XMLParser::NQXMLTreeParser
- XMLRPC::XMLParser::REXMLStreamParser
- XMLRPC::XMLParser::REXMLStreamParser::StreamListener
- XMLRPC::XMLParser::StreamParserMixin
- XMLRPC::XMLParser::XMLParser
- XMLRPC::XMLParser::XMLScanStreamParser
- XMLRPC::XMLParser::XMLScanStreamParser::XMLScanParser
- XMLRPC::XMLParser::XMLStreamParser
- XMLRPC::XMLParser::XMLTreeParser
- XMLRPC::XMLWriter
- XMLRPC::XMLWriter::Abstract
- XMLRPC::XMLWriter::Simple
- XMLRPC::XMLWriter::XMLParser

No matching classes.

# XMLRPC::Server

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

     require "xmlrpc/server"

    s = XMLRPC::Server.new(8080)

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

    s.add_handler("michael.div") do |a,b|
      if b == 0
        raise XMLRPC::FaultException.new(1, "division by zero")
      else
        a / b
      end
    end

    s.set_default_handler do |name, *args|
      raise XMLRPC::FaultException.new(-99, "Method #{name} missing" +
                                       " or wrong number of parameters!")
    end

    s.serve

### Public Class Methods

new(port=8080, host="127.0.0.1", 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 XMLRPC::BasicServer.new.

                   # File xmlrpc/server.rb, line 574
    def initialize(port=8080, host="127.0.0.1", maxConnections=4, stdlog=$stdout, audit=true, debug=true, *a)
      super(*a)
      require 'webrick'
      @server = WEBrick::HTTPServer.new(:Port => port, :BindAddress => host, :MaxClients => maxConnections,
                                        :Logger => WEBrick::Log.new(stdlog))
      @server.mount("/", self)
    end

### 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 584
    def serve
      signals = %w[INT TERM HUP] & Signal.list.keys
      signals.each { |signal| trap(signal) { @server.shutdown } }

      @server.start
    end

shutdown() click to toggle source

Stops and shuts the server down.

                   # File xmlrpc/server.rb, line 592
    def shutdown
      @server.shutdown
    end