Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • xmlrpc/server.rb

XMLRPC::CGIServer

XMLRPC::CGIServer

Synopsis

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

Description

Implements a CGI-based XML-RPC server.

Superclass

((<XMLRPC::BasicServer>))

Class Methods

Public Class Methods

new(*a) click to toggle source
 
               # File xmlrpc/server.rb, line 438
def CGIServer.new(*a)
  @@obj = super(*a) if @@obj.nil?
  @@obj
end
            
new(*a) click to toggle source
 
               # File xmlrpc/server.rb, line 443
def initialize(*a)
  super(*a)
end
            

Public Instance Methods

serve() click to toggle source
 
               # File xmlrpc/server.rb, line 447
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.size != length

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

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 Documenting-ruby.org.

blog comments powered by Disqus