UploadConnectionLatency Property

Type: Integer

Returns the latency in milliseconds of the visitor's connection speed for uploads..

Note: You must set the SpeedCheckType property to indicate you wish to use the Progressive testing method, set the SupportFilesRoot property as required by the Progressive testing method, and call the GetExtPropertiesEx method, before checking the value of this property.

Note: Use of this property requires the Enterprise Edition of BrowserHawk.

Tip: See the uploadspeed.asp sample for a working example of the upload connection latency test.

Example:

<% set bhObj = Server.CreateObject("cyScape.browserObj")

bhObj.SetExtProperties "UploadConnectionSpeed, UploadConnectionLatency"

bhObj.GetExtPropertiesEx

<html>

Your upload connection speed in bits per second is: <% = bhObj.ConnectionSpeed %> <br>

Your upload connection latency in milliseconds is: <% = bhObj.ConnectionLatency %> <p>

Your upload connection speed for nicely formatted display purposes is: <% = bhObj.Translate("UploadConnectionSpeed") %> <p>

</html>

Special notes for this property:

The UploadConnectionLatency test is not included when calling GetExtPropertiesEx with the "all" keyword. Therefore you must explicitly pass "UploadConnectionLatency" as a parameter to SetExtProperties to check for upload connection latency. If you do not call the GetExtPropertiesEx method prior to checking the UploadConnectionLatency property, the UploadConnectionLatency property returns -2.
If you are already performing a UploadConnectionSpeed test then testing UploadConnectionLatency does not add any additional testing time, bandwidth or overhead to the testing process. This is because the UploadConnectionSpeed test detects latency as a standard part of the speed test. However if you are not explicitly testing UploadConnectionSpeed and only request UploadConnectionLatency, then a full UploadConnectionSpeed test is run (just as if you had explicitly requested it) because it is required to determine the latency.
In the event the UploadConnectionLatency test times out (as determined by UploadSpeedCheckMaxWait) or an error occurs during testing, the UploadConnectionLatency property returns -1.
For proper operation of this test please ensure that your web server is configured to allow POST operations of data up to 2MB in size, or at least as large as the value specified in the UploadSpeedCheckMaxDatasize property, if you changed this from its default value. In some cases this may not be mandatory - the important thing is that the web server does not abort the post operation.
The UploadConnectionLatency property is only supported with IE 8+ (and not in Compatibility Mode), Firefox 3.5+, Safari 4+, and Chrome 5+ browsers. All other browsers will return -2 for UploadConnectionLatency.
Using the UploadConnectionLatency property may result in increased charges from your hosting provider due to the bandwidth used during testing. See Detecting Upload Speeds for more information and tips on reducing this bandwidth.
Detecting upload latency will not work with IIS versions 5 and earlier (if using IIS, requires IIS 6+).
If the user’s JavaScript is disabled this property will not be available and a value of -2 is returned