OpenSim.Framework.Servers.HttpServer.OSHttpResponse Class Reference

OSHttpResponse is the OpenSim representation of an HTTP response. More...

Inheritance diagram for OpenSim.Framework.Servers.HttpServer.OSHttpResponse:

Collaboration diagram for OpenSim.Framework.Servers.HttpServer.OSHttpResponse:

Public Member Functions
	OSHttpResponse ()
	OSHttpResponse (IHttpResponse resp)
	OSHttpResponse (OSHttpRequest req)
	Instantiate an OSHttpResponse object from an OSHttpRequest object. </summary Parameters req Incoming OSHttpRequest to which we are replying More...
	OSHttpResponse (HttpResponse resp, IHttpClientContext clientContext)
void	AddHeader (string key, string value)
	Add a header field and content to the response. More...
void	Send ()
	Send the response back to the remote client More...
void	FreeContext ()

Protected Attributes
IHttpResponse	_httpResponse

Properties
virtual string	ContentType [get, set]
	Content type property. More...
long	ContentLength [get, set]
	Boolean property indicating whether the content type property actively has been set. More...
long	ContentLength64 [get, set]
	Alias for ContentLength. More...
Encoding	ContentEncoding [get, set]
	Encoding of the body content. More...
bool	KeepAlive [get, set]
int	KeepAliveTimeout [get, set]
	Get or set the keep alive timeout property (default is 20). Setting this to 0 also disables KeepAlive. Setting this to something else but 0 also enable KeepAlive. More...
Stream	OutputStream [get]
	Return the output stream feeding the body. More...
string	ProtocolVersion [get, set]
Stream	Body [get]
	Return the output stream feeding the body. More...
string	RedirectLocation [set]
	Set a redirct location. More...
bool	SendChunked [get, set]
	Chunk transfers. More...
virtual int	StatusCode [get, set]
	HTTP status code. More...
string	StatusDescription [get, set]
	HTTP status description. More...
bool	ReuseContext [get, set]
Properties inherited from OpenSim.Framework.Servers.HttpServer.IOSHttpResponse
string	ContentType [get, set]
	Content type property. More...
long	ContentLength [get, set]
	Boolean property indicating whether the content type property actively has been set. More...
long	ContentLength64 [get, set]
	Alias for ContentLength. More...
Encoding	ContentEncoding [get, set]
	Encoding of the body content. More...
bool	KeepAlive [get, set]
int	KeepAliveTimeout [get, set]
	Get or set the keep alive timeout property (default is 20). Setting this to 0 also disables KeepAlive. Setting this to something else but 0 also enable KeepAlive. More...
Stream	OutputStream [get]
	Return the output stream feeding the body. More...
string	ProtocolVersion [get, set]
Stream	Body [get]
	Return the output stream feeding the body. More...
string	RedirectLocation [set]
	Set a redirct location. More...
bool	SendChunked [get, set]
	Chunk transfers. More...
int	StatusCode [get, set]
	HTTP status code. More...
string	StatusDescription [get, set]
	HTTP status description. More...
bool	ReuseContext [get, set]

Detailed Description

OSHttpResponse is the OpenSim representation of an HTTP response.

Definition at line 39 of file OSHttpResponse.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Servers.HttpServer.OSHttpResponse.OSHttpResponse ( )

inline

Definition at line 282 of file OSHttpResponse.cs.

OpenSim.Framework.Servers.HttpServer.OSHttpResponse.OSHttpResponse ( IHttpResponse  resp )

inline

Definition at line 284 of file OSHttpResponse.cs.

OpenSim.Framework.Servers.HttpServer.OSHttpResponse.OSHttpResponse ( OSHttpRequest  req )

inline

Instantiate an OSHttpResponse object from an OSHttpRequest object. </summary

Parameters

req	Incoming OSHttpRequest to which we are replying

Definition at line 295 of file OSHttpResponse.cs.

OpenSim.Framework.Servers.HttpServer.OSHttpResponse.OSHttpResponse ( HttpResponse  resp, IHttpClientContext  clientContext  )

inline

Definition at line 300 of file OSHttpResponse.cs.

Member Function Documentation

void OpenSim.Framework.Servers.HttpServer.OSHttpResponse.AddHeader ( string  key, string  value  )

inline

Add a header field and content to the response.

Parameters

key	string containing the header field name
value	string containing the header field value

Implements OpenSim.Framework.Servers.HttpServer.IOSHttpResponse.

Definition at line 313 of file OSHttpResponse.cs.

Here is the caller graph for this function:

void OpenSim.Framework.Servers.HttpServer.OSHttpResponse.FreeContext ( )

inline

Definition at line 332 of file OSHttpResponse.cs.

void OpenSim.Framework.Servers.HttpServer.OSHttpResponse.Send ( )

inline

Send the response back to the remote client

Definition at line 321 of file OSHttpResponse.cs.

Member Data Documentation

IHttpResponse OpenSim.Framework.Servers.HttpServer.OSHttpResponse._httpResponse

protected

Definition at line 279 of file OSHttpResponse.cs.

Property Documentation

Stream OpenSim.Framework.Servers.HttpServer.OSHttpResponse.Body

get

Return the output stream feeding the body.

Definition at line 191 of file OSHttpResponse.cs.

Encoding OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ContentEncoding

getset

Encoding of the body content.

Definition at line 104 of file OSHttpResponse.cs.

long OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ContentLength

getset

Boolean property indicating whether the content type property actively has been set.

IsContentTypeSet will go away together with .NET base.

Length of the body content; 0 if there is no body.

Definition at line 79 of file OSHttpResponse.cs.

long OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ContentLength64

getset

Alias for ContentLength.

Definition at line 95 of file OSHttpResponse.cs.

virtual string OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ContentType

getset

Content type property.

Setting this property will also set IsContentTypeSet to true.

Definition at line 49 of file OSHttpResponse.cs.

bool OpenSim.Framework.Servers.HttpServer.OSHttpResponse.KeepAlive

getset

Definition at line 117 of file OSHttpResponse.cs.

int OpenSim.Framework.Servers.HttpServer.OSHttpResponse.KeepAliveTimeout

getset

Get or set the keep alive timeout property (default is 20). Setting this to 0 also disables KeepAlive. Setting this to something else but 0 also enable KeepAlive.

Definition at line 138 of file OSHttpResponse.cs.

Stream OpenSim.Framework.Servers.HttpServer.OSHttpResponse.OutputStream

get

Return the output stream feeding the body.

On its way out...

Definition at line 167 of file OSHttpResponse.cs.

string OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ProtocolVersion

getset

Definition at line 175 of file OSHttpResponse.cs.

string OpenSim.Framework.Servers.HttpServer.OSHttpResponse.RedirectLocation

set

Set a redirct location.

Definition at line 202 of file OSHttpResponse.cs.

bool OpenSim.Framework.Servers.HttpServer.OSHttpResponse.ReuseContext

getset

Definition at line 261 of file OSHttpResponse.cs.

bool OpenSim.Framework.Servers.HttpServer.OSHttpResponse.SendChunked

getset

Chunk transfers.

Definition at line 215 of file OSHttpResponse.cs.

virtual int OpenSim.Framework.Servers.HttpServer.OSHttpResponse.StatusCode

getset

HTTP status code.

Definition at line 231 of file OSHttpResponse.cs.

string OpenSim.Framework.Servers.HttpServer.OSHttpResponse.StatusDescription

getset

HTTP status description.

Definition at line 248 of file OSHttpResponse.cs.

---

The documentation for this class was generated from the following file:

• Framework/Servers/HttpServer/OSHttpResponse.cs