SYNCERのロゴ
アイキャッチ画像

XMLHttpRequest.timeout - 時間制限

timeoutは、XMLHttpRequestのメソッドです。ajax通信に時間制限を設定できます。

概要

名前
timeout
所属
XMLHttpRequest
IDL
attribute unsigned long timeout;
仕様書
https://xhr.spec.whatwg.org/#dom-xmlhttprequest-timeout

説明

ミリ秒単位の数値を指定します。0を指定した場合、無制限となります。

時間制限により通信を終了した場合、timeoutイベントが発生し、XMLHttpRequestEventTarget.ontimeoutでキャッチできます。

デモ

XMLHttpRequest.timeoutのデモです。ボタンをクリックすると、ある画像をダウンロードします。1msというありえない時間制限を設定したため、ajax通信はタイムアウトになるはずです。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
body { word-break: break-all ; tab-size: 2 ; }
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<p><button id="send">通信 [send()]</button></p>
<hr>
<img src="" id="hoge" width="120" height="auto">
<hr>
<div id="result"></div>
<script>
var xhr = new XMLHttpRequest() ;
xhr.responseType = "blob" ;
xhr.timeout = 1 ;

xhr.onloadstart = function ( event ) {
	appendText( "[loadstart] ダウンロードを開始しました!!" + "\n" ) ;
}

xhr.onprogress = function ( event ) {
	appendText( "[progress] ダウンロード中…" + "\n" ) ;
}

xhr.onload = function ( event ) {
	appendText( "[load] ダウンロードが正常に完了しました!!" + "\n" ) ;
}

xhr.onloadend = function ( event ) {
	appendText( "[loadend] ダウンロードを終了しました!!" + "\n" ) ;
}

xhr.onerror = function ( event ) {
	appendText( "[error] ダウンロードに失敗しました…。" + "\n" ) ;
}

xhr.ontimeout = function ( event ) {
	appendText( "[timeout] タイムアウトです。" + "\n" ) ;
}

xhr.addEventListener( "load", function ( event ) {
	var blob = xhr.response ;
	var blobUrl = URL.createObjectURL( blob ) ;
	document.getElementById( "hoge" ).src = blobUrl ;
} ) ;

document.getElementById( "send" ).onclick = function () {
	xhr.open( "GET", "./image.png" ) ;
	xhr.send() ;
}

function appendText ( text ) {
	document.getElementById( "result" ).appendChild( document.createTextNode( text ) ) ;
}
</script>
</body>
</html>

サポート状況

ChromeFirefoxSafariEdgeIEOperaiOS SafariAndroid
29+ 12+ 7.1+ 16+ 7.0+
  • Twitterでシェア
  • Facebookでシェア
  • Google+でシェア
  • はてなブックマークでシェア
  • pocketに保存
  • LINEでシェア
更新履歴
2017年10月23日 (月)
コンテンツを公開しました。