Class: XMLRPC::CGIServer

Inherits:
BasicServer show all
Defined in:
lib/xmlrpc/server.rb

Overview

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!

Constant Summary collapse

@@obj = 
nil

Constants inherited from BasicServer

BasicServer::ERR_MC_EXPECTED_STRUCT, BasicServer::ERR_MC_MISSING_METHNAME, BasicServer::ERR_MC_MISSING_PARAMS, BasicServer::ERR_MC_RECURSIVE_CALL, BasicServer::ERR_MC_WRONG_PARAM, BasicServer::ERR_MC_WRONG_PARAM_PARAMS, BasicServer::ERR_METHOD_MISSING, BasicServer::ERR_UNCAUGHT_EXCEPTION

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicServer

#add_handler, #add_introspection, #add_multicall, #get_default_handler, #get_service_hook, #process, #set_default_handler, #set_service_hook

Methods included from ParseContentType

#parse_content_type

Methods included from ParserWriterChooseMixin

#set_parser, #set_writer

Constructor Details

#initialize(*a) ⇒ CGIServer

Returns a new instance of CGIServer.



395
396
397
 
# File 'lib/xmlrpc/server.rb', line 395

def initialize(*a)
  super(*a)
end

Class Method Details

.new(*a) ⇒ Object

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.



390
391
392
393
 
# File 'lib/xmlrpc/server.rb', line 390

def CGIServer.new(*a)
  @@obj = super(*a) if @@obj.nil?
  @@obj
end

Instance Method Details

#serve ⇒ Object

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.



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/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