From e8509e69764a86ea04daaa3f6f661968b85d3a19 Mon Sep 17 00:00:00 2001 From: Frank Wuerthwein Date: Sun, 8 Feb 2009 03:22:28 +0000 Subject: Initial version --- doc/lib/binaryXHR_js.html | 210 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) create mode 100644 doc/lib/binaryXHR_js.html (limited to 'doc') diff --git a/doc/lib/binaryXHR_js.html b/doc/lib/binaryXHR_js.html new file mode 100644 index 0000000..b5d1764 --- /dev/null +++ b/doc/lib/binaryXHR_js.html @@ -0,0 +1,210 @@ + + + + + binaryXHR module + + + + + + + + + + +

binaryXHR module

+ + + + +

The binaryXHR Javascript + module implements a set of functions and classes that can be + used to retrieve binary files using the XMLHttpRequest + API.

Overview

This module provides two functions, +FetchBinaryURL and +FetchBinaryURLAsync, +that are wrappers around the +XMLHttpRequest API +and return an object of type +BinaryFile. +The first one implements a +straight load, while the second one initiates an asynchronous +operation handled by a callback function.

The BinaryFile class implements the methods needed to access the +elements of the binary files, such as strings, integers and real +numbers. +

Both the functions and the class internally handle the differences +between different Web Browsers, so the user of this module does not +need to worry about them.

+ +

Function FetchBinaryURL

+ +

Load a binary file.

Arguments:

url:string – URL from where to load the binary file.
+

Output:

An object of type BinaryFile.
+

+ +

Function FetchBinaryURLAsync

+ +

Initiate an asynchronous binary load.

Arguments:

url:string – URL from where to load the binary file.
+
callback:function(obj) – Pointer to the function that will + be called when the binary file has been loaded. He function will be + given a single argument; an object of type BinaryFile.
+

Output:

None. The callback function will receive the loaded file.
+

+ +

Class BinaryFile

+ +

This class implements the methods needed to access the content of +the binary file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Method +	+ Description +
+ getLength() +	+ Return the number of bytes held by the object. +
+ getByteAt(idx) +	+ Return an 8 bit unsigned integer from offset idx. +
+ getShortAt(idx) +	+ Return a 16 bit little endian unsigned integer from offset + idx. + +
+ getLongAt(idx) +	+ Return a 32 bit little endian unsigned integer from offset + idx. +
+ getDoubleAt(idx) +	+ Return a double float (64 bit little endian) from offset idx. +
+ getFastDoubleAt(idx) +	+ Return a low resolution (20 bit mantissa) double flat + obtained from the high 32 bits of the original little endian + double float from offset idx. +
+ getCharAt(idx) +	+ Get a character from offset idx. +
+ getCStringAt(idx,maxlen) +	+ Get a zero terminated string of limited size from offset idx. + + +
+ getStringAt(idx,len) +	+ Get a fixed length string from offset idx. +

+ +

Class InvalidBinaryFile

+ +

This is a helper exception class that can be thrown while loading the binary file.

+ + + + +

This module is part of the javascriptRRD + package hosted at http://javascript.sourceforge.net. +
It is licensed under the MIT + licanse. +

+ + -- cgit v1.2.3