lib/yui/connection/README

   1 Connection Manager Release Notes
   2
   3 *** version 2.3.0 ***
   4
   5 * Custom Events are introduced in Connection Manager.  These events -- for a
   6 non-file upload transaction -- are:
   7
   8    * startEvent
   9    * completeEvent
  10    * successEvent
  11    * failureEvent
  12    * abortEvent
  13
  14 For transactions involving file upload with an HTML form, the events are:
  15
  16    * startEvent
  17    * completeEvent
  18    * uploadEvent
  19    * abortEvent
  20
  21 * Event utility is a now Connection Manager dependency.
  22
  23 * abort() and isCallInProgress() are now functional for file upload
  24 transactions.
  25
  26 * NOTE: The XHR implementation in Safari 2.0.4 has been confirmed to leak
  27 memory.
  28
  29 * UPDATE: The XHR implementation in Safari 3.0 beta(and WebKit builds) now
  30 appear to handle HTTP 204 responses correctly.  XHR in Opera, as of 9.21, still
  31 does not produce a valid HTTP status code with an HTTP 204 response.
  32
  33 *** version 2.2.2 ***
  34
  35 * No revisions.
  36
  37 *** version 2.2.1 ***
  38
  39 * setForm() will include the correct name-value of the HTML Submit button
  40 clicked where multiple HTML Submit button options are present in an HTML form.
  41 To enable this feature, include the Event utility source file as a dependency
  42 before the Connection Manager source file.
  43
  44 * The XHR implementation in IE6 and IE7, Opera, and Safari do not properly
  45 handle an HTTP 204 response.  IE6/7 will instead return a Win error 1223.
  46 handleTransactionResponse() will treat 1223 as an HTTP 204, and route the
  47 response appropriately to the success callback.  createResponseObject() will
  48 normalize the response object's status and statusText values to 204 and "No
  49 Content" respectively.  However, no headers are returned.
  50
  51 Opera and Safari provide no discernable response with HTTP 204(e.g., response
  52 object's properties are undefined).  This response will trigger the failure
  53 callback with a status of 0 and statusText of "communication failure".
  54
  55 *** version 2.2.0 ***
  56
  57 * initHeader() now accepts a third argument as a boolean.  When set to true,
  58 this specific header will automatically be sent with each transaction.
  59 Otherwise, the header will be set and sent for the specific transaction only.
  60 Example: initHeader('X-YUI-State','Beta', true); all transactions will send this
  61 header.
  62    * resetDefaultHeaders() will clear the default headers collection.
  63
  64 * All Connection Mananger transactions will broadcast the header: "X-Requested-
  65 With: XMLHttpRequest".
  66    * This can be turned off: YAHOO.util.Connect.setDefaultXhrHeader(false);
  67
  68 * The HTTP method argument in asyncRequest is now case-insensitive.
  69
  70 * uploadFile() will now correctly handle the absence of a callback object,
  71 allowing the transaction to complete silently.
  72
  73 *** version 0.12.2 ***
  74
  75 * The Opera/Connection Manager concurrent object condition, described in version
  76 0.12.0, no longer tests applies for Opera, version 9.10.
  77
  78 *** version 0.12.1 ***
  79
  80 * connection-debug.js corrected and synchronized with connection.js.  Code
  81 inconsistencies between the two files existed in 0.12.0.
  82
  83 *** version 0.12.0 ***
  84
  85 * When uploading files via setForm() and asyncRequest includes a POST data
  86 argument, appendPostData() will create hidden input fields for each postData
  87 label/value and append each field to the form object.
  88
  89 * setForm() returns the assembled label/value string of the parsed HTML form
  90 fields.
  91
  92 * NOTE: Opera 9.02 does not allow for more than 12 concurrent Connection Manager
  93 objects.
  94
  95 The following example creates 12 requests in a loop:
  96 for(var n=0; n<=12; i++){
  97   conn[n] = YAHOO.util.Connect.asyncRequest('GET', sUrl, callback);
  98 }
  99
 100 If n > 13, Opera 9.02 will crash.  Connection manager objects count n must be <=
 101 12 at all times.  This condition was not present in Opera version 9.01.
 102
 103 This condition does not apply to other A-Grade browsers (
 104 http://developer.yahoo.com/yui/articles/gbs/gbs_browser-chart.html)
 105
 106 *** version 0.11.3 ***
 107
 108 * YUI Event dependency for file uploading is now optional.
 109
 110 * uploadFile() now sets unique IDs for each file upload transaction to prevent
 111 iframe collisions with parallel uploads.
 112
 113 * The callback object now has property responseXML to provide support for file
 114 upload transactions that return an XML document.
 115
 116 * setForm() will verify if a select option value attribute is present and use
 117 its value, including empty string, before using the text node value.
 118
 119 * Modified polling mechanism in handleReadyState() and
 120 handleTransactionResponse() to prevent infinite polling if JavaScript errors
 121 occur in the user-defined callback.
 122
 123 * createFrame() will now accept a boolean argument of true to set the frame
 124 source to "javascript:false" to prevent IE from throwing security warnings in an
 125 HTTPS environment.
 126
 127 * setHeader() now enumerates through the _http_header object using
 128 hasOwnProperty() to prevent collisions with members added to Object via
 129 prototype.
 130
 131 * If using setForm() and asyncRequest includes a POST data argument, the data
 132 will be concatenated to the HTML form POST message.
 133
 134 *** version 0.11.2 ***
 135
 136 * No revisions.
 137
 138 *** version 0.11.1 ***
 139
 140 * uploadFile() now verifies the existence of callback.upload before invoking
 141 callback, with or without object scope.
 142
 143 *** version 0.11.0 ***
 144
 145 * Each transaction can be defined with a timeout threshold, in milliseconds,
 146 through the callback object.  If the threshold is reached, and the transaction
 147 hasn't yet completed, the transaction will call abort().
 148
 149 * abort() will now accept a callback object as the second argument.  The
 150 failure callback will receive a response object to indicate the transaction was
 151 aborted.
 152
 153 * setForm() will now support file uploads by setting the second argument to
 154 true (e.g., YAHOO.util.Connect.setForm(formObject, true).  File upload does not
 155 use the callback success or failure handler.  Instead, it uses a new callback
 156 object handler: upload.
 157
 158 * HTML form submit will no longer submit form fields without a defined name
 159 attribute.
 160
 161 * The default POST header of 'Content-Type','application/x-www-form-urlencoded'
 162 can be overridden by calling setDefaultPostHeader(false).  This
 163 will remove the default header from non-HTML form, POST submissions.
 164
 165 * setHeader() now enumerates through the _http_header object with
 166 propertyIsEnumerable to prevent collisions with members added to Object via
 167 prototype.
 168
 169 *** version 0.10.0 ***
 170
 171 * handleTransactionResponse() now treats the full HTTP 2xx range as a success
 172 case, instead of just HTTP 200.
 173
 174 * To accommodate multiple field values in Mozilla/Firefox, multiple initHeader
 175 calls with the same label will now result in the values concatenated to a
 176 comma- delimited string value.
 177 Example:
 178 Setting Content-Type:'application/x-www-form-urlencoded' and Content-
 179 Type:'text/xml' will result in Content-Type:'application/x-www-form-urlencoded,
 180 text/xml'.
 181
 182 * Default polling interval lowered to 50ms.
 183
 184 * YAHOO.util.Connect.setPollingInterval() will allow you to set a polling
 185 interval -- in milliseconds -- to override the default value.
 186
 187 * YAHOO.util.Connect.getResponseHeader[headerLabel] now supported as a response
 188 object property to provide symmetry with the native XHR object's property.
 189 Example:
 190 YAHOO.util.Connect.getResponseHeader['Content-Length'] will return the value
 191 for the Content-Length header, if the header is available.
 192
 193 * YAHOO.util.Connect.allResponseHeaders property renamed to
 194 getAllResponseHeaders to provide symmetry with the native XHR object's
 195 property.
 196
 197 * YAHOO.util.Connect.setForm() now supports HTTP GET as well as HTTP POST.
 198
 199 * YAHOO.util.Connect.setForm() now accepts an HTML form object as well as its
 200 name attribute value.
 201
 202 * YAHOO.util.Connect.setForm() will not submit HTML form fields that are
 203 disabled or do not have a name attribute value.
 204
 205 * [FIXED] Response exceptions result in infinite callback loop in
 206 Mozilla/Firefox.
 207
 208 * [FIXED] YAHOO.util.Connect.abort() now properly clears polling interval.
 209
 210 * [FIXED] isCallInProgress() now verifies whether XHR instance still exists,
 211 and returns false if the connection object is no longer available.
 212
 213 *** version 0.9.0 ***
 214
 215 * Initial release
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240