Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > xmlrpc/serverライブラリ > XMLRPC::BasicServerクラス

class XMLRPC::BasicServer

クラスの継承リスト: XMLRPC::BasicServer < Object < Kernel

要約

Is the base class for all XML-RPC server-types (CGI, standalone). You can add handler and set a default handler. Do not use this server, as this is/should be an abstract class.

How the method to call is found

The arity (number of accepted arguments) of a handler (method or Proc object) is compared to the given arguments submitted by the client for a RPC ((-Remote Procedure Call-)). A handler is only called if it accepts the number of arguments, otherwise the search for another handler will go on. When at the end no handler was found, the XMLRPC::BasicServer#set_default_handler will be called. With this technique it is possible to do overloading by number of parameters, but only for Proc handler, because you cannot define two methods of the same name in the same class.

特異メソッド

定義	説明
`new(class_delim=".")`	Creates a new XMLRPC::BasicServer instance, which should not be done, because XMLRPC::BasicServer is an abstract class. This method should be called from a subclass indirectly by a super call in the method initialize. The paramter class_delim is used in [[mXMLRPC::BasicServer#add_handler]] when an object is added as handler, to delimit the object-prefix and the method-name.

インスタンスメソッド

定義	説明
`add_handler(name, signature=nil, help=nil) { aBlock }`	Adds aBlock to the list of handlers, with name as the name of the method. Parameters signature and help are used by the Introspection method if specified, where signature is either an Array containing strings each representing a type of it's signature (the first is the return value) or an Array of Arrays if the method has multiple signatures. Value type-names are "int, boolean, double, string, dateTime.iso8601, base64, array, struct".
`add_handler(prefix, obj)`	This is the second form of [[unknown:add_handler\|XMLRPC::BasicServer#add_handler]]. To add an object write: server.add_handler("michael", MyHandlerClass.new) All public methods of MyHandlerClass are accessible to the XML-RPC clients by (('michael."name of method"')). This is where the class_delim in [[unknown:new\|XMLRPC::BasicServer.new]] has it's role, a XML-RPC method-name is defined by prefix + class_delim + (('"name of method"')).
`add_handler(interface, obj)`	This is the third form of [[unknown:add_handler\|XMLRPC::BasicServer#add_handler]].
`add_introspection`	Adds the introspection handlers "system.listMethods", "system.methodSignature" and "system.methodHelp", where only the first one works.
`add_multicall`	Adds the multi-call handler "system.multicall".
`get_default_handler`	Returns the default-handler, which is called when no handler for a method-name is found. It is a Proc object or nil.
`get_service_hook`	Returns the service-hook, which is called on each service request (RPC) unless it's nil.
`set_default_handler(&handler)`	Sets handler as the default-handler, which is called when no handler for a method-name is found. handler is a code-block. The default-handler is called with the (XML-RPC) method-name as first argument, and the other arguments are the parameters given by the client-call.
`set_parser(parser)`	Sets the XML parser to use for parsing XML documents. Should be an instance of a class from module XMLRPC::XMLParser. If this method is not called, then XMLRPC::Config::DEFAULT_PARSER is used.
`set_service_hook(&handler)`	A service-hook is called for each service request (RPC). You can use a service-hook for example to wrap existing methods and catch exceptions of them or convert values to values recognized by XMLRPC. You can disable it by passing nil as parameter handler .
`set_writer(writer)`	Sets the XML writer to use for generating XML output. Should be an instance of a class from module XMLRPC::XMLWriter. If this method is not called, then XMLRPC::Config::DEFAULT_WRITER is used.

継承したメソッド

== === =~ __id__ __send__ _dump class clone dclone display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method method_missing methods nil? pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods public_methods remove_instance_variable respond_to? singleton_method_added singleton_method_removed singleton_method_undefined singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str to_yaml to_yaml_properties to_yaml_style untaint