ResponseDataSender Class

Class that writes data to the given context's response and handles multipart and range requests.

Inheritance Hierarchy

System.Object
  CMS.Helpers.ResponseDataSender

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23

Syntax

public class ResponseDataSender

The ResponseDataSender type exposes the following members.

Constructors

	Name	Description
Public method	ResponseDataSender	Creates a new ResponseDataSender instance.

Methods

	Name	Description
Public method	GetRange	Parses the range header from the request.
Public method	WriteBytes	Streams the byte array to the response.
Public method	WriteFile	Streams the data file to the response.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	BUFFER_SIZE	Buffer size 64 kB.
Public field Static member	CONNECTION_CHECK	Check connection every X buffering iterations.
Public field Static member	CONNECTION_TIMEOUT	Connection timeout (seconds).
Public field Static member	RANGE_END	Range end constant
Public field Static member	RANGE_START	Range start constant
Public field Static member	STREAM_LIMIT_SLEEP	Wait interval when stream limit was reached before next check.

Properties

	Name	Description
Public property	AcceptRange	Indicates if resumable downloads should be supported for current file.
Public property Static member	AcceptRanges	Indicates whether range requests are enabled (ex. for resumable downloads). If false, the HTTP Handler ignores the Range HTTP Header and returns the entire contents.
Public property	AreRangesValid	Indicates whether ranges are valid. TRUE: ranges are valid or request is not range request FALSE: all other cases
Protected property	Context	Current HTTP context.
Public property	DataLength	Size of data.
Public property	IsMultipart	Indicates whether it is multipart range request.
Public property	IsRangeRequest	Indicates whether it is range request.
Public property	LogCommunicationExceptions	Whether to log exception caused by communication problems (e.g. when remote host closes the connection). Log exceptions has to be set to TRUE.
Public property	LogExceptions	Logs the exceptions caused by the process.
Public property	MaxByteStream	Maximum streaming speed in bytes per second.
Public property	Ranges	2D Array in format {{START_RANGE,END_RANGE},{START_RANGE, END_RANGE}}.
Protected property	Response	Current HTTP response.