Version: Unity 6.1 Beta (6000.1)
LanguageEnglish
  • C#

UnityWebRequest.timeout

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public int timeout;

Description

The number of seconds after which UnityWebRequest attempts to abort the request if no response is received.

The default value is 0 which means no timeout is applied and UnityWebRequest will wait until the response is received.

When the response takes longer than the value specified in timeout, UnityWebRequest.error returns Request timeout message.

using UnityEngine;
using System.Collections;
using UnityEngine.Networking;

// Ask the website to deliver an image that is very large. // Set the download to take more than 60 seconds. This causes // the "request timeout" error message.

public class ExampleScript : MonoBehaviour { void Start() { StartCoroutine(GetText()); }

IEnumerator GetText() { using UnityWebRequest www = UnityWebRequest.Get("https://my-website.com/verylargeimage.jpg");

// Set the timeout to 60 seconds. // Abort the request if the image doesn't download within the specified timeout. www.timeout = 60; yield return www.SendWebRequest();

if (www.result != UnityWebRequest.Result.Success) { Debug.LogError(www.error); } else { Debug.Log("image arrived"); } } }