home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _491dd305658e209a04097c5fb60363a4 < prev    next >
Text File  |  2000-03-23  |  5KB  |  144 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>HTTP::Message - Class encapsulating HTTP messages</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> HTTP::Message - Class encapsulating HTTP messages</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.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>HTTP::Message - Class encapsulating HTTP messages</P>
  33. <P>
  34. <HR>
  35. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  36. <UL>
  37. <LI>Linux</LI>
  38. <LI>Solaris</LI>
  39. <LI>Windows</LI>
  40. </UL>
  41. <HR>
  42. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  43. <PRE>
  44.  package HTTP::Request;  # or HTTP::Response
  45.  require HTTP::Message;
  46.  @ISA=qw(HTTP::Message);</PRE>
  47. <P>
  48. <HR>
  49. <H1><A NAME="description">DESCRIPTION</A></H1>
  50. <P>A <CODE>HTTP::Message</CODE> object contains some headers and a content (body).
  51. The class is abstract, i.e. it only used as a base class for
  52. <CODE>HTTP::Request</CODE> and <CODE>HTTP::Response</CODE> and should never instantiated
  53. as itself.</P>
  54. <P>The following methods are available:</P>
  55. <DL>
  56. <DT><STRONG><A NAME="item_%24mess_%3D_new_HTTP%3A%3AMessage%3B">$mess = new HTTP::Message;</A></STRONG><BR>
  57. <DD>
  58. This is the object constructor.  It should only be called internally
  59. by this library.  External code should construct <CODE>HTTP::Request</CODE> or
  60. <CODE>HTTP::Response</CODE> objects.
  61. <P></P>
  62. <DT><STRONG><A NAME="item_clone">$mess-><CODE>clone()</CODE></A></STRONG><BR>
  63. <DD>
  64. Returns a copy of the object.
  65. <P></P>
  66. <DT><STRONG><A NAME="item_protocol">$mess-><CODE>protocol([$proto])</CODE></A></STRONG><BR>
  67. <DD>
  68. Sets the HTTP protocol used for the message.  The <A HREF="#item_protocol"><CODE>protocol()</CODE></A> is a string
  69. like ``HTTP/1.0'' or ``HTTP/1.1''.
  70. <P></P>
  71. <DT><STRONG><A NAME="item_content">$mess-><CODE>content([$content])</CODE></A></STRONG><BR>
  72. <DD>
  73. The <A HREF="#item_content"><CODE>content()</CODE></A> method sets the content if an argument is given.  If no
  74. argument is given the content is not touched.  In either case the
  75. previous content is returned.
  76. <P></P>
  77. <DT><STRONG><A NAME="item_add_content">$mess-><CODE>add_content($data)</CODE></A></STRONG><BR>
  78. <DD>
  79. The <A HREF="#item_add_content"><CODE>add_content()</CODE></A> methods appends more data to the end of the previous
  80. content.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_content_ref">$mess->content_ref</A></STRONG><BR>
  83. <DD>
  84. The <A HREF="#item_content_ref"><CODE>content_ref()</CODE></A> method will return a reference to content string.
  85. It can be more efficient to access the content this way if the content
  86. is huge, and it can be used for direct manipulation of the content,
  87. for instance:
  88. <PRE>
  89.   ${$res->content_ref} =~ s/\bfoo\b/bar/g;</PRE>
  90. <P></P>
  91. <DT><STRONG><A NAME="item_headers">$mess->headers;</A></STRONG><BR>
  92. <DD>
  93. Return the embedded HTTP::Headers object.
  94. <P></P>
  95. <DT><STRONG><A NAME="item_headers_as_string">$mess-><CODE>headers_as_string([$endl])</CODE></A></STRONG><BR>
  96. <DD>
  97. Call the HTTP::Headers-><CODE>as_string()</CODE> method for the headers in the
  98. message.
  99. <P></P></DL>
  100. <P>All unknown <CODE>HTTP::Message</CODE> methods are delegated to the
  101. <CODE>HTTP::Headers</CODE> object that is part of every message.  This allows
  102. convenient access to these methods.  Refer to <A HREF="../../../site/lib/HTTP/Headers.html">the HTTP::Headers manpage</A> for
  103. details of these methods:</P>
  104. <PRE>
  105.   $mess->header($field => $val);
  106.   $mess->scan(\&doit);
  107.   $mess->push_header($field => $val);
  108.   $mess->remove_header($field);</PRE>
  109. <PRE>
  110.   $mess->date;
  111.   $mess->expires;
  112.   $mess->if_modified_since;
  113.   $mess->if_unmodified_since;
  114.   $mess->last_modified;
  115.   $mess->content_type;
  116.   $mess->content_encoding;
  117.   $mess->content_length;
  118.   $mess->content_language
  119.   $mess->title;
  120.   $mess->user_agent;
  121.   $mess->server;
  122.   $mess->from;
  123.   $mess->referer;
  124.   $mess->www_authenticate;
  125.   $mess->authorization;
  126.   $mess->proxy_authorization;
  127.   $mess->authorization_basic;
  128.   $mess->proxy_authorization_basic;</PRE>
  129. <P>
  130. <HR>
  131. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  132. <P>Copyright 1995-1997 Gisle Aas.</P>
  133. <P>This library is free software; you can redistribute it and/or
  134. modify it under the same terms as Perl itself.</P>
  135. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  136. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  137. <STRONG><P CLASS=block> HTTP::Message - Class encapsulating HTTP messages</P></STRONG>
  138. </TD></TR>
  139. </TABLE>
  140.  
  141. </BODY>
  142.  
  143. </HTML>
  144.