Class: XMLRPC::CGIServer (Ruby 2.3.7)
Description: Class : XMLRPC::CGIServer - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

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

### Home Classes Methods

### In Files

- xmlrpc/server.rb

### Parent

XMLRPC::BasicServer

### Methods

- ::new
- ::new
- #serve

### 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::CGIServer

Implements a CGI-based XML-RPC server.

    require "xmlrpc/server"

    s = XMLRPC::CGIServer.new

    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

Note: Make sure that you don't write to standard-output in a handler, or in any other part of your program, this would cause a CGI-based server to fail!

### Public Class Methods

new(*a) click to toggle source

Creates a new XMLRPC::CGIServer instance.

All parameters given are by-passed to XMLRPC::BasicServer.new.

You can only create one XMLRPC::CGIServer instance, because more than one makes no sense.

                   # File xmlrpc/server.rb, line 390
    def CGIServer.new(*a)
      @@obj = super(*a) if @@obj.nil?
      @@obj
    end

new(*a) click to toggle source

                   # File xmlrpc/server.rb, line 395
    def initialize(*a)
      super(*a)
    end

### Public Instance Methods

serve() click to toggle source

Call this after you have added all you handlers to the server.

This method processes a XML-RPC method call and sends the answer back to the client.

                   # File xmlrpc/server.rb, line 403
    def serve
      catch(:exit_serve) {
        length = ENV['CONTENT_LENGTH'].to_i

        http_error(405, "Method Not Allowed") unless ENV['REQUEST_METHOD'] == "POST"
        http_error(400, "Bad Request")        unless parse_content_type(ENV['CONTENT_TYPE']).first == "text/xml"
        http_error(411, "Length Required")    unless length > 0

        # TODO: do we need a call to binmode?
        $stdin.binmode if $stdin.respond_to? :binmode
        data = $stdin.read(length)

        http_error(400, "Bad Request")        if data.nil? or data.bytesize != length

        http_write(process(data), "Content-type" => "text/xml; charset=utf-8")
      }
    end