home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _06833961fda1900ce6947df9a36a460e < prev    next >
Text File  |  2000-03-23  |  5KB  |  147 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>SOAP::Envelope - Creates SOAP streams</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> SOAP::Envelope - Creates SOAP streams</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#the new function">The new function</A></LI>
  28.         <LI><A HREF="#the header function">The header function</A></LI>
  29.         <LI><A HREF="#the body function">The body function</A></LI>
  30.         <LI><A HREF="#the term function">The term function</A></LI>
  31.     </UL>
  32.  
  33.     <LI><A HREF="#dependencies">DEPENDENCIES</A></LI>
  34.     <LI><A HREF="#author">AUTHOR</A></LI>
  35.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  36. </UL>
  37. <!-- INDEX END -->
  38.  
  39. <HR>
  40. <P>
  41. <H1><A NAME="name">NAME</A></H1>
  42. <P>SOAP::Envelope - Creates SOAP streams</P>
  43. <P>
  44. <HR>
  45. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  46. <UL>
  47. <LI>Linux</LI>
  48. <LI>Solaris</LI>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <PRE>
  54.     use SOAP::Envelope;</PRE>
  55. <PRE>
  56.     sub output_fcn {
  57.         my $string = shift;
  58.         print $string;
  59.     }</PRE>
  60. <PRE>
  61.     my $namespaces_to_preload = ["urn:foo", "urn:bar"];
  62.     my $env = SOAP::Envelope->new(\&output_fcn,
  63.                                   $namespaces_to_preload);
  64.     my $header = $env->header("urn:a", "MyHeaderA",
  65.                               undef, undef,
  66.                               0, 0);
  67.     ...
  68.     $header->term();</PRE>
  69. <PRE>
  70.     $header = $env->header("urn:b", "MyHeaderB",
  71.                            undef, undef,
  72.                            0, 0);
  73.     ...
  74.     $header->term();</PRE>
  75. <PRE>
  76.     my $body = $env->body("urn:c", "MyCall",
  77.                           undef, undef);
  78.     ...
  79.     $body->term();</PRE>
  80. <PRE>
  81.     $env->term();</PRE>
  82. <P>
  83. <HR>
  84. <H1><A NAME="description">DESCRIPTION</A></H1>
  85. <P>This class bootstraps and manages the serialization of an object graph
  86. into a SOAP stream. It is used by the SOAP::Transport classes, but may
  87. be used directly as well.</P>
  88. <P>
  89. <H2><A NAME="the new function">The new function</A></H2>
  90. <P>Creates a new envelope. If you know you'll be using certain namespaces
  91. a lot, you can save some space by preloading those namespaces (pass the
  92. set of URI strings as an array when creating a new envelope, as in the example
  93. above).</P>
  94. <P>
  95. <H2><A NAME="the header function">The header function</A></H2>
  96. <P>Creates a new header in the specified namespace URI (which is required).
  97. You can call this function multiple times to create several different headers,
  98. but don't call the body function until you've created all the headers.
  99. If omitted, the typename and typeuri will be taken from the accessor name
  100. and accessor uri, but the accessor name and uri are required.
  101. Be sure to <CODE>term()</CODE> the current header before creating a new one.
  102. For a discussion of the $object optional parameter, please see body(), below.</P>
  103. <P>
  104. <H2><A NAME="the body function">The body function</A></H2>
  105. <P>Creates the body. You can only call this function once per envelope,
  106. and you must call it after you're done creating all the headers you need
  107. to create. If omitted, the typename and typeuri will be taken from the accessor
  108. name and accessor uri, but the accessor name is required.
  109. The $object parameter is optional, but must be passed if headers (or subelements
  110. in the body) may point to the body itself. SOAP::Envelope adds this object
  111. reference into its identity dictionary to correctly deal with these cases
  112. (a doubly-linked list is a simple example of this case).
  113. If you pass $object, you have to be prepared for <CODE>body()</CODE> to return undef,
  114. which indicates that the object was already marshaled into the header area
  115. (because it was referred to by a header element). In this case, the body
  116. element will simply be a reference to the previously marshaled body.
  117. If <CODE>body()</CODE> returns a value, don't forget to call <CODE>term()</CODE> through it when you're done
  118. serializing the body, because this forces the output of any outstanding multi-ref
  119. items.</P>
  120. <P>
  121. <H2><A NAME="the term function">The term function</A></H2>
  122. <P>This writes an end tag, terminating the SOAP envelope.</P>
  123. <P>
  124. <HR>
  125. <H1><A NAME="dependencies">DEPENDENCIES</A></H1>
  126. <P>SOAP::OutputStream
  127. SOAP::Packager
  128. SOAP::Defs</P>
  129. <P>
  130. <HR>
  131. <H1><A NAME="author">AUTHOR</A></H1>
  132. <P>Keith Brown</P>
  133. <P>
  134. <HR>
  135. <H1><A NAME="see also">SEE ALSO</A></H1>
  136. <P>SOAP::OutputStream
  137. SOAP::Transport::HTTP</P>
  138. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  139. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  140. <STRONG><P CLASS=block> SOAP::Envelope - Creates SOAP streams</P></STRONG>
  141. </TD></TR>
  142. </TABLE>
  143.  
  144. </BODY>
  145.  
  146. </HTML>
  147.