Devil Killer Is Here MiNi Shell
MiNi SheLL

Current Path : /proc/thread-self/root/usr/local/man/man3/
Linux boscustweb5002.eigbox.net 5.4.91 #1 SMP Wed Jan 20 18:10:28 EST 2021 x86_64
Current File : //proc/thread-self/root/usr/local/man/man3/SOAP::EnvelopeMaker.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SOAP::EnvelopeMaker 3"
.TH SOAP::EnvelopeMaker 3 "2000-09-05" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
SOAP::EnvelopeMaker \- Creates SOAP envelopes
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use SOAP::EnvelopeMaker;
.PP
my \f(CW$soap_request\fR = '';
my \f(CW$output_fcn\fR = sub {
    \f(CW$soap_request\fR .= shift;
};
my \f(CW$em\fR = SOAP::EnvelopeMaker\->new($output_fcn);
.PP
my \f(CW$body\fR = SOAP::Struct\->new(
    origin => { x => 10,  y => 20  },
    corner => { x => 100, y => 200 },
);
.PP
$em\->set_body(\*(L"urn:com\-develop\-geometry\*(R", \*(L"calculateArea\*(R", 0, \f(CW$body\fR);
.PP
my \f(CW$host\fR        = \*(L"soapl.develop.com\*(R";
my \f(CW$port\fR        = 80;
my \f(CW$endpoint\fR    = \*(L"/soap?class=Geometry\*(R";
my \f(CW$method_uri\fR  = \*(L"urn:com\-develop\-geometry\*(R";
my \f(CW$method_name\fR = \*(L"calculateArea\*(R";
.PP
use SOAP::Transport::HTTP::Client;
.PP
my \f(CW$soap_on_http\fR = SOAP::Transport::HTTP::Client\->\fInew()\fR;
.PP
my \f(CW$soap_response\fR = \f(CW$soap_on_http\fR\->send_receive($host, \f(CW$port\fR, \f(CW$endpoint\fR,
                                                \f(CW$method_uri\fR,
                                                \f(CW$method_name\fR,
                                                \f(CW$soap_request\fR);
use SOAP::Parser;
my \f(CW$soap_parser\fR = SOAP::Parser\->\fInew()\fR;
\&\f(CW$soap_parser\fR\->parsestring($soap_response);
.PP
my \f(CW$area\fR = \f(CW$soap_parser\fR\->\fIget_body()\fR\->{result};
.PP
print \*(L"The area is: \f(CW$area\fR\en\*(R";
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The overall usage pattern of SOAP::EnvelopeMaker is as follows:
.PP
1) Determine what you want to do with the resulting \s-1SOAP\s0 packet
   and create an output function that implements this policy.
.PP
2) Create an instance of SOAP::EnvelopeMaker, passing a reference
   to your output function, or to a string if you were just planning
   on buffering the output anyway (in this case, you'll get an output
   function that looks like this: sub {$$r .= shift}
.PP
(note that somebody may already have done these first two steps
 on your behalf and simply passed you a reference to a pre-initialized
 EnvelopeMaker \- see SOAP::Transport::HTTP::Server for an example)
.PP
3) (optional) Call add_header one or more times to specify headers.
.PP
4) (required) Call set_body to specify the body.
.PP
5) Throw away the EnvelopeMaker and do something with the envelope
   that you've collected via your output function (assuming you've
   not simply been piping the output somewhere as it's given to you).
.PP
EnvelopeMaker expects that you'll add *all* your headers *before*
setting the body \- if you mess this up, the results are undefined.
.PP
By the time set_body returns, a complete \s-1SOAP\s0 envelope will have been
sent to your output function (in one or more chunks). You can 
.Sh "new(OutputFcn)"
.IX Subsection "new(OutputFcn)"
OutputFcn should accept a single scalar parameter, and will be called
multiple times with chunks of the \s-1SOAP\s0 envelope as it is constructed.
You can either append these chunks into a big string, waiting until
the entire envelope is constructed before you do something with it
(like calculate the content\-length, for instance), or you can simply
pipe each chunk directly to somebody else.
.PP
As of version 0.25, you can now pass a string reference for OutputFcn
and the EnvelopeMaker will provide a very simple buffering output
function (one that we all ended up writing anyway during testing):
sub {$$r .= shift}
.Sh "add_header(AccessorUri, AccessorName, MustUnderstand, IsPackage, Object)"
.IX Subsection "add_header(AccessorUri, AccessorName, MustUnderstand, IsPackage, Object)"
The first two parameters allow you to specify a QName (qualified name)
for your header. Note that in \s-1SOAP\s0, all headers \s-1MUST\s0 be namespace
qualified. MustUnderstand and IsPackage turn on \s-1SOAP\s0 features that are
explained in the \s-1SOAP\s0 spec; if you haven't yet grok'd \s-1SOAP\s0 packages,
just pass 0 for IsPackage. Finally, Object is whatever you'd like to
serialize into the header (see set_body for notes on what can go here;
headers can contain the same stuff as the body).
.Sh "set_body(AccessorUri, AccessorName, IsPackage, Object)"
.IX Subsection "set_body(AccessorUri, AccessorName, IsPackage, Object)"
The first two parameters allow you to specify a QName (qualified name)
for the body. The name of the accessor is the name of the \s-1SOAP\s0 method
call you're making. IsPackage says that the body will be a \s-1SOAP\s0 package;
just pass 0 if you're not sure what this means. Object is whatever you'd
like to serialize. This can be one of the following things:
.PP
1) a scalar \- the body will contain the scalar content.
.PP
2) a hash reference \- the body will contain a \s-1SOAP\s0 serialized version
                      of the contents of the hash.
.PP
3) a SOAP::Struct reference \- the body will contain a \s-1SOAP\s0 serialized
                              version of the struct, where the serialized
                              contents of the struct will be in the same
                              order in the \s-1SOAP\s0 bar as they appeared
                              in the SOAP::Struct constructor.
.PP
Note that the SOAP/Perl serialization architecture deals with references
very carefully, so it is possible to pass arbitrary object graphs (although
each \*(L"object reference\*(R" must currently be a non-blessed scalar or hash reference).
.PP
In the future, expect to see support for passing blessed object references
(if you want to do this today, see the experimental SOAP::TypeMapper).
SOAP::Struct is an example of this.
.PP
One interesting thing \s-1SOAP\s0 (and SOAP/Perl) support is that the headers
and body can share references. They can point to the same stuff. Also,
cycle detection is a natural part of SOAP/Perl's serialization architecture,
so you can pass linked lists, circular queues, etc. and they will be
rehydrated correctly.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
SOAP::Envelope
.SH "AUTHOR"
.IX Header "AUTHOR"
Keith Brown
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SOAP::Envelope
Creat By MiNi SheLL
Email: devilkiller@gmail.com