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

FreeBSD Manual Pages

  
 
  

home | help
XML::Compile::TransporUserOContriXutedCPerllD::Transport::SOAPHTTP_AnyEvent(3)

NAME
       XML::Compile::Transport::SOAPHTTP_AnyEvent - exchange XML via
       AnyEvent::HTTP

INHERITANCE
	XML::Compile::Transport::SOAPHTTP_AnyEvent
	  is a XML::Compile::Transport
	  is a XML::Compile::SOAP::Extension

SYNOPSIS
	use XML::Compile::Transport::SOAPHTTP_AnyEvent;

	my $http = XML::Compile::Transport::SOAPHTTP_AnyEvent->new(@options);
	my $send = $http->compileClient(@options2);

	my $call = $wsdl->compileClient
	  ( operation => 'some-port-name'
	  , transport => $send
	  , async     => 1	# required!
	  );

	sub handler
	  { my ($xmlout, $trace) = @_;
	    # so something
	  };

	$call->($xmlin,	_callback => \&handler);

DESCRIPTION
       This module handles the exchange	of (XML) messages, according to	the
       rules of	SOAP (any version).  The module	does not known how to parse or
       compose XML, but	only worries about the HTTP aspects.

       In contrairy to XML::Compile::Transport::SOAPHTTP, this implementation
       can be used in various event-driven environments, via AnyEvent::HTTP.

       Extends "DESCRIPTION" in	XML::Compile::Transport.

METHODS
       Extends "METHODS" in XML::Compile::Transport.

   Constructors
       Extends "Constructors" in XML::Compile::Transport.

       XML::Compile::Transport::SOAPHTTP_AnyEvent->new(%options)
	    -Option	     --Defined in	      --Default
	     address	       XML::Compile::Transport	'http://localhost'
	     any_event_params				[]
	     charset	       XML::Compile::Transport	'utf-8'

	   address => URI|ARRAY-of-URI
	   any_event_params => ARRAY
	     Options passed to AnyEvent::HTTP, for instance "timeout" and
	     "proxy".  The ARRAY is a list of PAIRS.

	   charset => STRING

   WSDL11
       Extends "WSDL11"	in XML::Compile::Transport.

       $obj->wsdl11Init($wsdl, $args)
       XML::Compile::Transport::SOAPHTTP_AnyEvent->wsdl11Init($wsdl, $args)
	   Inherited, see "WSDL11" in XML::Compile::SOAP::Extension

   SOAP11
       Extends "SOAP11"	in XML::Compile::Transport.

       $obj->soap11ClientWrapper($operation, $call, $args)
	   Inherited, see "SOAP11" in XML::Compile::SOAP::Extension

       $obj->soap11HandlerWrapper($operation, $callback, $args)
	   Inherited, see "SOAP11" in XML::Compile::SOAP::Extension

       $obj->soap11OperationInit($operation, $args)
       XML::Compile::Transport::SOAPHTTP_AnyEvent->soap11OperationInit($operation,
       $args)
	   Inherited, see "SOAP11" in XML::Compile::SOAP::Extension

   SOAP12
       Extends "SOAP12"	in XML::Compile::Transport.

       $obj->soap12ClientWrapper($operation, $call, $args)
	   Inherited, see "SOAP12" in XML::Compile::SOAP::Extension

       $obj->soap12HandlerWrapper($operation, $callback, $args)
	   Inherited, see "SOAP12" in XML::Compile::SOAP::Extension

       $obj->soap12OperationInit($operation, $args)
       XML::Compile::Transport::SOAPHTTP_AnyEvent->soap12OperationInit($operation,
       $args)
	   Inherited, see "SOAP12" in XML::Compile::SOAP::Extension

   Accessors
       Extends "Accessors" in XML::Compile::Transport.

       $obj->address()
	   Inherited, see "Accessors" in XML::Compile::Transport

       $obj->addresses()
	   Inherited, see "Accessors" in XML::Compile::Transport

       $obj->anyEventParams()
       $obj->charset()
	   Inherited, see "Accessors" in XML::Compile::Transport

   Handlers
       Extends "Handlers" in XML::Compile::Transport.

       $obj->compileClient(%options)
	   Compile an HTTP client handler.  Returned is	a subroutine which is
	   called with a text represenation of the XML request,	or an
	   XML::LibXML tree.  In SCALAR	context, an XML::LibXML	parsed tree of
	   the answer message is returned.  In LIST context, that answer is
	   followed by a HASH which contains trace information.

	    -Option    --Defined in		--Default
	     action				  ''
	     header				  <created>
	     hook	 XML::Compile::Transport  <undef>
	     kind				  'request-response'
	     method				  'POST'
	     mime_type				  <depends on soap version>
	     mpost_id				  42
	     soap				  'SOAP11'
	     xml_format	 XML::Compile::Transport  0

	   action => URI
	   header => HTTP::Headers object
	     Versions of XML::Compile, XML::Compile::SOAP, and LWP will	be
	     added to simplify bug reports.

	   hook	=> CODE
	   kind	=> DIRECTION
	     What kind of interactie, based on the four	types defined by
	     WSDL(1): "notification-operation" (server initiated, no answer
	     required),	"one-way" (client initiated, no	answer required),
	     "request-response"	(client	initiated, the usual in	both
	     directions), "solicit-response" (server initiated "challenge").

	   method => 'POST'|'M-POST'
	     With "POST", you get the standard HTTP exchange.  The "M-POST" is
	     implements	the (Microsoft)	HTTP Extension Framework.  Some
	     servers accept both, other	require	a specific request.

	   mime_type =>	STRING
	   mpost_id => INTEGER
	     With method "M-POST", the header extension	fields require (any)
	     number to be grouped.

	   soap	=> 'SOAP11'|'SOAP12'|OBJECT
	   xml_format => 0|1|2
       $obj->headerAddVersions($header)
       XML::Compile::Transport::SOAPHTTP_AnyEvent->headerAddVersions($header)
	   Adds	some lines about module	versions, which	may help debugging or
	   error reports.  This	is called when a new client or server is being
	   created.

DETAILS
       Extends "DETAILS" in XML::Compile::Transport.

SYNOPSYS
       Extends "SYNOPSYS" in XML::Compile::Transport.

Helpers
       Extends "Helpers" in XML::Compile::Transport.

       XML::Compile::Transport::SOAPHTTP_AnyEvent->register($uri)
	   Inherited, see "Helpers" in XML::Compile::Transport

SEE ALSO
       This module is part of XML-Compile-SOAP-AnyEvent	distribution version
       0.90, built on February 15, 2016. Website:
       http://perl.overmeer.net/xml-compile/

       Other distributions in this suite: XML::Compile,	XML::Compile::SOAP,
       XML::Compile::WSDL11, XML::Compile::SOAP12, XML::Compile::SOAP::Daemon,
       XML::Compile::SOAP::WSA,	XML::Compile::C14N, XML::Compile::WSS,
       XML::Compile::WSS::Signature, XML::Compile::Tester,
       XML::Compile::Cache, XML::Compile::Dumper, XML::Compile::RPC,
       XML::Rewrite and	XML::LibXML::Simple.

       Please post questions or	ideas to the mailinglist at
       http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/xml-compile .	For
       live contact with other developers, visit the "#xml-compile" channel on
       "irc.perl.org".

LICENSE
       Copyrights 2010-2016 by [Aleksey	Mashanov/Mark Overmeer]. For other
       contributors see	ChangeLog.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.32.0			 XML::Compile::Transport::SOAPHTTP_AnyEvent(3)

NAME | INHERITANCE | SYNOPSIS | DESCRIPTION | METHODS | DETAILS | SYNOPSYS | Helpers | SEE ALSO | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XML::Compile::Transport::SOAPHTTP_AnyEvent&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help