Ajax/jQuery Abort on timeout

Question

Newbie - Quesiton -

Problem trying to solve: In case there are some open connections that aren't closed by XMLHttprequest, we want to abort them.

In a javascript file, where there are Ajax calls, I need to start a timer for each call, and clear the timer in both success and failure callbacks. Want to make sure that - if timer fires then it means request has not returned, so it should be aborted. For cases where inspite of the abort, the request may come back - want to discard them. Want to add a flag which checks success and failure callbacks before processing, and handles appropriately.

Want to add a timer like this :

    var timer = setTimeout(function() {         // Start a timer. If triggered,
                           timedout = true; // set a flag and then
                           request.abort(); // abort the request.
                       },
                       timeout);            // time specified

But in the given existing code like below, I finding it hard on understanding where to start my timer and abort.

        this.ajaxCall = function(urlSuffix, type, data, successCallback, errorCallback, callbackParam, logFlag)
 {
    if (!successCallback) {
        throw "A successCallback must be supplied";
    }
    if (!errorCallback) {
        throw "An errorCallback must be supplied";
    }
    var st = 0;
    if (logFlag !== false)
        st = LogMessageTestCL(urlSuffix + " - start: " + type, -1);
    $.ajax({
        url: urlRoot + urlSuffix,
        type: type,
        data: data,
        cache: false,

        success: function(msg) {
            try {
                if (logFlag !== false)
                    LogMessageTestCL(urlSuffix + " - end: " + type, st);
                successCallback(msg, callbackParam);
            }
            catch (e) {
                // this will only fail when the calling page is unloaded before the call returns, so no need to log this
            }
        },
        error: function(xhr,status) { 
            try {
                if (logFlag !== false)
                    LogMessageTestCL(urlSuffix + " - error end: " + type, st);
                if (status === "timeout") {
                    alert("30 sec time out");   
                    LogMessageTestCL("callback timed out");
                    return;
                }
                else if (status === "error") {
                    if (xhr.status != 200) {
                        errorCallback(xhr, callbackParam);
                    }
                }
                else
                    errorCallback(xhr, callbackParam);
            }
            catch (e) {
                // this will only fail when the calling page is unloaded before the call returns, so no need to log this
            }
        }
    });
}

Any help is greatly appreciated.

Arun P Johny · Accepted Answer · 2013-08-27 00:08:13Z

3

There is no need to implement the logic yourself and the timeout option is provided by jquery, look at the documentation of jQuery.ajax() there is an option called timeout.

Ex:

$.ajax({
    url: '',
    type: '',
    data: '',
    timeout: 30000, //time in milliseconds - 30000 equals 30 seconds,
    ......
})

answered Aug 27, 2013 at 0:08

Arun P Johny

389k68 gold badges532 silver badges532 bronze badges

Sign up to request clarification or add additional context in comments.

12 Comments

user1834443 Over a year ago

Thank you Arun for responding. On top of the timeout given by JQuery - we do want to add this abort. Is there a way to explicitly do so?

Arun P Johny Over a year ago

@user1834443 what do you mean by abort? what should happen then

user1834443 Over a year ago

I meant - abort the request - like xhr.abort() - do you think this is not necessary?

Arun P Johny Over a year ago

@user1834443 so you do not want to call the fail callback in case of timeout error

user1834443 Over a year ago

I want to start and clear a timer for both success and failure callbacks. If timer fires then it means request has not returned, and in those cases abort the request.

|

Collectives™ on Stack Overflow

Ajax/jQuery Abort on timeout

1 Answer 1

12 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

12 Comments

Your Answer

Sign up or log in

Post as a guest

Related