From: Michael Wallner <mike@php.net>
Date: Mon, 7 Nov 2005 13:50:53 +0000 (+0000)
Subject: - some notes about user space objects
X-Git-Tag: RELEASE_0_18_0~34
X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=commitdiff_plain;h=28baf7ddd547d83881952cfd1720cc4b3c342d79;ds=sidebyside

- some notes about user space objects
---

diff --git a/http_request_object.c b/http_request_object.c
index 8ea4da6..fbddcc6 100644
--- a/http_request_object.c
+++ b/http_request_object.c
@@ -1874,6 +1874,13 @@ PHP_METHOD(HttpRequest, getResponseMessage)
  * references the last received response.  Use HttpMessage::getParentMessage()
  * to access the data of previously sent requests whithin this request
  * cycle.
+ * 
+ * Note that the internal request message is immutable, that means that the
+ * request message received through HttpRequest::getRequestMessage() will
+ * always look the same for the same request, regardless of any changes you
+ * may have made to the returned object.
+ * 
+ * Throws HttpMalformedHeadersException, HttpEncodingException.
  */
 PHP_METHOD(HttpRequest, getRequestMessage)
 {
@@ -1905,7 +1912,11 @@ PHP_METHOD(HttpRequest, getRequestMessage)
  * The object references the last received response, use HttpMessage::getParentMessage() 
  * to access the data of previously sent requests and received responses.
  * 
- * Throws HttpMalformedHeaderException.
+ * Note that the internal history is immutable, that means that any changes
+ * you make the the message list won't affect a history message list newly 
+ * created by another call to HttpRequest::getHistory().
+ * 
+ * Throws HttpMalformedHeaderException, HttpEncodingException.
  */
 PHP_METHOD(HttpRequest, getHistory)
 {