Subscribing to Connection Manager's Custom Events via the Callback Object
<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.
Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library
YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.
* Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
* Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
* Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
* Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Subscribing to Connection Manager's Custom Events via the Callback Object</title>
<style type="text/css">
/*margin and padding on body element
can introduce errors in determining
element position and are not recommended;
we turn them off as a foundation for YUI
CSS treatments. */
body {
margin:0;
padding:0;
}
</style>
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" />
<script type="text/javascript" src="yui_2.7.0b-lib/yahoo/yahoo-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/event/event-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/connection/connection-min.js"></script>
<!--begin custom header content for this example-->
<style>
#container {margin-left:2em;}
</style>
<!--end custom header content for this example-->
</head>
<body class=" yui-skin-sam">
<h1>Subscribing to Connection Manager's Custom Events via the Callback Object</h1>
<div class="exampleIntro">
<p>
<a href="http://developer.yahoo.com/yui/connection/">Connection Manager</a> exposes <a href="http://developer.yahoo.com/yui/event/#customevent">Custom Events</a> that track the progress of a transaction throughout its lifecycle. These Custom Events are raised at the global level and at the transaction level. The following code example provides a step-by-step approach to subscribing to transactional Custom Events raised by Connection Manager. In this scenario, an event handler object is created to handle all of the Custom Events; this event handler object is passed to Connection Manager in the callback object. Connection Manager will automatically subscribe to the events and fire the specified events.
</p>
<p>Click "Send a Request" below to try it out, then read the description below to learn how to subscribe to transactional Custom Events in Connection Manager.</p>
</div>
<!--BEGIN SOURCE CODE FOR EXAMPLE -->
<form>
<input type="button" onclick="makeRequest();" value="Send a Request">
</form>
<div id="container"></div>
<script>
var div = document.getElementById('container');
var transactionObject = {
start:function(type, args){
YAHOO.log("Custom Event *start* fired for transaction" + args[0].tId + ".", "info", "example");
div.innerHTML = "<li>Transaction " + args[0].tId + " " + type + " event fired.</li>";
},
complete:function(type, args){
YAHOO.log("Custom Event *complete* fired for transaction" + args[0].tId + ".", "info", "example");
div.innerHTML += "<li>Transaction " + args[0].tId + " " + type + " event fired.</li>";
},
success:function(type, args){
YAHOO.log("Custom Event *success* fired for transaction" + args[0].tId + ".", "info", "example");
div.innerHTML += "<li>Transaction " + args[0].tId + " " + type + " event fired.</li>";
if(args[0].responseText !== undefined){
div.innerHTML += "<li>Transaction id: " + args[0].tId + "</li>";
div.innerHTML += "<li>HTTP status: " + args[0].status + "</li>";
div.innerHTML += "<li>Status code message: " + args[0].statusText + "</li>";
div.innerHTML += "<li>HTTP headers: " + args[0].getAllResponseHeaders + "</li>";
div.innerHTML += "<li>Server response: " + args[0].responseText + "</li>";
div.innerHTML += "<li>Argument object: Array ( [foo] => " + args[0].argument[0] +" [bar] => " + args[0].argument[1] +" )</li>";
}
},
failure:function(type, args){
YAHOO.log("Custom Event *failure* fired for transaction" + args[0].tId + ".", "info", "example");
div.innerHTML += "<li>Transaction " + args[0].tId + " " + type + " event fired.</li>";
if(args[0].responseText !== undefined){
div.innerHTML += "<li>Transaction id: " + args[0].tId + "</li>";
div.innerHTML += "<li>HTTP status: " + args[0].status + "</li>";
div.innerHTML += "<li>Status code message: " + args[0].statusText + "</li>";
}
},
abort:function(type, args){
YAHOO.log("Custom Event *abort* fired for transaction" + args[0].tId + ".", "info", "example");
div.innerHTML += "<li>Transaction " + args[0].tId + " " + type + " event fired.</li>";
}
};
var handleSuccess = function(o){
div.innerHTML += "<li>Success response handler triggered in callback.success</li>";
};
var handleFailure = function(o){
div.innerHTML += "<li>Failure response handler triggered in callback.success</li>";
};
var callback = {
success:handleSuccess,
failure:handleFailure,
customevents:{
onStart:transactionObject.start,
onComplete:transactionObject.complete,
onSuccess:transactionObject.success,
onFailure:transactionObject.failure,
onAbort:transactionObject.abort
},
argument:["foo","bar"]
};
function makeRequest(){
var sUrl = "yui_2.7.0b-assets/connection-assets/get.php?s=hello%20world";
var request = YAHOO.util.Connect.asyncRequest('GET', sUrl, callback);
};
</script>
<!--END SOURCE CODE FOR EXAMPLE -->
</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:10 PST 2009 -->
yui_2.7.0b.zip( 4,431 k)Related examples in the same category