Thursday, May 24, 2012

Abort Ajax requests using jQuery


Using jQuery, how can I cancel/abort an Ajax request that I have not yet received the response from?



Source: Tips4all

5 comments:

  1. Most of the jQuery Ajax methods return an XMLHttpRequest (or the equivalent) object, so you can just use abort().

    See the documentation:


    abort Method (MSDN). Cancels the current HTTP request.
    abort() (MDC). If the request has been sent already, this method will abort the request.




    var xhr = $.ajax({
    type: "POST",
    url: "some.php",
    data: "name=John&location=Boston",
    success: function(msg){
    alert( "Data Saved: " + msg );
    }
    });

    //kill the request
    xhr.abort()


    UPDATE:
    As of jQuery 1.5 the returned object is a wrapper for the native XMLHttpRequest object called jqXHR. This object appears to expose all of the native properties and methods so the above example still works. See The jqXHR Object (jQuery API documentation).

    ReplyDelete
  2. It's an asynchronous request, meaning once it's sent it's out there.

    In case your server is starting a very expensive operation due to the AJAX request, the best you can do is open your server to listen for cancel requests, and send a separate AJAX request notifying the server to stop whatever it's doing.

    Otherwise, simply ignore the AJAX response.

    ReplyDelete
  3. You can't recall the request but you can set a timeout value after which the response will be ignored. See this page for jquery AJAX options. I believe that your error callback will be called if the timeout period is exceeded. There is already a default timeout on every AJAX request.

    ReplyDelete
  4. meouw's solution is correct, but if you're are interested in more control then you could try the Ajax Manager plugin for jQuery.

    ReplyDelete
  5. Save the calls you make on a array, then call xhr.abort() on each.

    HUGE CAVEAT: you can abort a request, but that only the clientside, the server side could still be running the request. If you are using something like PHP/ASP with session data, the session data is locked until the ajax has finished. So to allow the user to continue browsing the website, you have to call session_write_close().

    ReplyDelete