Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Protocol::XMLRPC::ClieUser)Contributed Perl DocumenProtocol::XMLRPC::Client(3)

NAME
       Protocol::XMLRPC::Client	- Simple XML-RPC client

SYNOPSIS
	   my $xmlrpc =	Protocol::XMLRPC::Client->new(
	       http_req_cb => sub {

		   ...

		   $cb->(..);
	       }
	   );

	   $xmlrpc->call(
	       'http://example.com/xmlrpc' => 'plus' =>	[1, 2] => sub {
		   my ($self, $method_response)	= @_;

		   print $method_response->param->value, "\n";
	       },
	       sub {
		   print "internal error\n";
	       }
	   );

DESCRIPTION
       Protocol::XMLRPC::Client	is a simple XML-RPC client. You	provide
       callback	subroutine for posting method requests.	LWP, AnyEvent::HTTP
       etc can be used for this	purpose.

ATTRIBUTES
   "http_req_cb"
	   my $xmlrpc =	Protocol::XMLRPC::Client->new(
	       http_req_cb => sub {
		   my ($self, $url, $method, $headers, $body, $cb) = @_;

		   ...

		   $cb->($self,	$status, $headers, $body);

       A callback for sending request to the xmlrpc server. Don't forget that
       User-Agent and Host headers are required	by XML-RPC specification.
       Default values are provided, but	you are	advised	to change them.

       Request callback	is called with:

       o   self	Protocol::XMLRPC::Client instance

       o   url server url (for example 'http://example.com/xmlrpc')

       o   method request method

       o   headers request headers hash	reference

       o   body	request	body to	send. Holds Protocol::XMLRPC::MethodCall
	   string representation.

       o   cb callback that must be called after response was received

       o   error_cb callback that is called on error (optional)

       Response	callback must be called	with:

       o   self	Protocol::XMLRPC::Client instance

       o   status response status (200,	404 etc)

       o   headers response headers hash reference

       o   body	response body

METHODS
   "new"
	   my $xmlrpc =	Protocol::XMLRPC::Client->new(http_req_cb => sub { ... });

       Creates Protocol::XMLRPC	instance. Argument http_req_cb is required.

   "call"
	   $xmlrpc->call(
	       'http://example.com/xmlrpc' => 'plus' =>	[1, 2] => sub {
		   my ($self, $method_response)	= @_;

		   ...
	       }
	   );

       Creates Protocol::XMLRPC::MethodCall object with	provided parameters
       and calls http_req_cb with url and body.	Upon response parses and
       created Protocol::XMLRPC::MethodResponse	object and calls provided
       callback.

       Parameter are optional. But must	be provided as an array	reference.
       Parameters types	are guessed (more about	that in
       Protocol::XMLRPC::ValueFactory).

perl v5.32.1			  2011-06-03	   Protocol::XMLRPC::Client(3)

NAME | SYNOPSIS | DESCRIPTION | ATTRIBUTES | METHODS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Protocol::XMLRPC::Client&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help