summaryrefslogtreecommitdiff
path: root/js/dojo/dojox/io/README
blob: ed355819891599b575cf4848cd2a13c84a1415c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
-------------------------------------------------------------------------------
DojoX IO
-------------------------------------------------------------------------------
Version 0.4.0
Release date: 07/04/2008
-------------------------------------------------------------------------------
Project state:
experimental
-------------------------------------------------------------------------------
Credits
	Bryan Forbes (bryan AT reigndropsfall.net)
	Kris Zyp (kris AT sitepen.com)
	James Burke (jburke AT dojotoolkit.org)
	Tom Trenka (ttrenka AT gmail.com)
	
-------------------------------------------------------------------------------
Project description

	A Collection of advanced and experimental IO modules:
	
	* scriptFrame.js - Uses an iframe for dojo.io.script requests. Useful in some
	long-polling comet situations in Firefox and Opera. Those browsers execute scripts
	in DOM order, not network-receive order, so a long-polling script will block other
	dynamically appended scripts from running until it completes. By using an iframe
	for the dojo.io.script requests, this issue can be avoided.

	* xhrMultiPart.js - Constructs multi-part mime XHR requests. Useful when wanting
	multi-part requests but not using a form with a file input. Note that it does not
	allow you to send files from local disks -- a form with a file input is required
	for that use case. xhrMultipart is not useful in that use case.

	* xhrPlugins.js - An adapter registry for having multiple XHR handlers (like
	XDomainRequest, CS-XHR, proxy, and window.name)

	* windowName.js - Cross-domain transport using window.name
	xhrWindowNamePlugin.js - window.name plugin for XHR adapter registry

	* httpParse.js - HTTP message parser. Parses to an XHR like interface.
	
	* OAuth.js - Object to be used for signing OpenAuth requests.  Includes easy
		wrappers for xhr.
	
-------------------------------------------------------------------------------
Dependencies:

DojoX IO xhrMultiPart depends on Dojo Core and DojoX UUID's generateRandomUuid 
function.

xhrWindowNamePlugin depends on dojox.secure.capability for safe JSON parsing

OAuth depends on dojox.encoding.digests.SHA1.
-------------------------------------------------------------------------------
Documentation

-------------------------------------------------------------------------------
Installation instructions

Grab the following from the Dojo SVN Repository:
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/uuid.js
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/uuid/*
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/secure/*
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/encoding/digests/*

Install into the following directory structure:
/dojox/uuid/
/dojox/secure/
/dojox/encoding/digests/

AND

Grab the following from the Dojo SVN Repository:
http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/io/*

Install into the following directory structure:
/dojox/io/

...both of which should be at the same level as your Dojo checkout.
-------------------------------------------------------------------------------
Additional Notes

The information contained in this README does not pertain to DojoX XHR IFrame Proxy.  
For that information see proxy/README.