Version: 2021.1
LanguageEnglish
  • C#

DownloadHandlerBuffer

class in UnityEngine.Networking

/

Inherits from:Networking.DownloadHandler

/

Implemented in:UnityEngine.UnityWebRequestModule

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

Description

A general-purpose DownloadHandler implementation which stores received data in a native byte buffer.

This is a general-purpose DownloadHandler subclass. It stores received data in native memory. It will preallocated a data buffer based on any received Content-Length header, but will expand its buffer should the actual download size exceed the value of Content-Length header (or if a Content-Length header is not received).

Note: When accessing DownloadHandler.data or DownloadHandler.text on this subclass, a new byte array or string will be allocated each time the property is accessed.

Constructors

DownloadHandlerBufferDefault constructor.

Static Methods

GetContentReturns a copy of the native-memory buffer interpreted as a UTF8 string.

Inherited Members

Properties

dataReturns the raw bytes downloaded from the remote server, or null. (Read Only)
errorError message describing a failure that occurred inside the download handler.
isDoneReturns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only)
nativeDataProvides direct access to downloaded data.
textConvenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only)

Public Methods

DisposeSignals that this DownloadHandler is no longer being used, and should clean up any resources it is using.

Protected Methods

CompleteContentCallback, invoked when all data has been received from the remote server.
GetDataCallback, invoked when the data property is accessed.
GetNativeDataProvides allocation-free access to the downloaded data as a NativeArray.
GetProgressCallback, invoked when UnityWebRequest.downloadProgress is accessed.
GetTextCallback, invoked when the text property is accessed.
ReceiveContentLengthHeaderCallback, invoked with a Content-Length header is received.
ReceiveDataCallback, invoked as data is received from the remote server.