/*
* Copyright (c) Contributors, http://opensimulator.org/
* See CONTRIBUTORS.TXT for a full list of copyright holders.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the OpenSimulator Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System.IO;
using System.Net;
using System.Text;
using OSHttpServer;
using System.Runtime.CompilerServices;
namespace OpenSim.Framework.Servers.HttpServer
{
///
/// OSHttpResponse is the OpenSim representation of an HTTP
/// response.
///
public class OSHttpResponse : IOSHttpResponse
{
///
/// Content type property.
///
///
/// Setting this property will also set IsContentTypeSet to
/// true.
///
public virtual string ContentType
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.ContentType; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.ContentType = value; }
}
///
/// Boolean property indicating whether the content type
/// property actively has been set.
///
///
/// IsContentTypeSet will go away together with .NET base.
///
// public bool IsContentTypeSet
// {
// get { return _contentTypeSet; }
// }
// private bool _contentTypeSet;
///
/// Length of the body content; 0 if there is no body.
///
public long ContentLength
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.ContentLength; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.ContentLength = value; }
}
///
/// Alias for ContentLength.
///
public long ContentLength64
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return ContentLength; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { ContentLength = value; }
}
///
/// Encoding of the body content.
///
public Encoding ContentEncoding
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Encoding; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Encoding = value; }
}
public bool KeepAlive
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Connection == ConnectionType.KeepAlive; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Connection = value ? ConnectionType.KeepAlive : ConnectionType.Close; }
}
///
/// 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.
///
public int KeepAliveTimeout
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.KeepAlive; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set
{
if (value == 0)
{
_httpResponse.Connection = ConnectionType.Close;
_httpResponse.KeepAlive = 0;
}
else
{
_httpResponse.Connection = ConnectionType.KeepAlive;
_httpResponse.KeepAlive = value;
}
}
}
///
/// Return the output stream feeding the body.
///
///
/// On its way out...
///
public Stream OutputStream
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Body; }
}
public string ProtocolVersion
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.ProtocolVersion; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.ProtocolVersion = value; }
}
///
/// Return the output stream feeding the body.
///
public Stream Body
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Body; }
}
public byte[] RawBuffer
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.RawBuffer; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.RawBuffer = value; }
}
public int RawBufferStart
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.RawBufferStart; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.RawBufferStart = value; }
}
public int RawBufferLen
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.RawBufferLen; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.RawBufferLen = value; }
}
public int Priority
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Priority; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Priority = value; }
}
///
/// Chunk transfers.
///
public bool SendChunked
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Chunked; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Chunked = value; }
}
///
/// HTTP status code.
///
public virtual int StatusCode
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return (int)_httpResponse.Status; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Status = (HttpStatusCode)value; }
}
public double RequestTS
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.RequestTS; }
}
///
/// HTTP status description.
///
public string StatusDescription
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get { return _httpResponse.Reason; }
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set { _httpResponse.Reason = value; }
}
protected readonly IHttpResponse _httpResponse;
public OSHttpResponse() {}
public OSHttpResponse(IHttpResponse resp)
{
_httpResponse = resp;
}
///
/// Instantiate an OSHttpResponse object from an OSHttpRequest
/// object.
/// Incoming OSHttpRequest to which we are
/// replying
public OSHttpResponse(OSHttpRequest req)
{
_httpResponse = new HttpResponse(req.IHttpRequest);
}
public OSHttpResponse(HttpResponse resp)
{
_httpResponse = resp;
}
///
/// Set response as a http redirect
///
/// redirection target url
/// the response Status, must be Found, Redirect, Moved,MovedPermanently,RedirectKeepVerb, RedirectMethod, TemporaryRedirect. Defaults to Redirect
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Redirect(string url, HttpStatusCode redirStatusCode = HttpStatusCode.Redirect)
{
_httpResponse.Redirect(url, redirStatusCode);
}
///
/// Add a header field and content to the response.
///
/// string containing the header field
/// name
/// string containing the header field
/// value
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void AddHeader(string key, string value)
{
_httpResponse.AddHeader(key, value);
}
///
/// Send the response back to the remote client
///
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Send()
{
_httpResponse.Chunked = false;
_httpResponse.Send();
}
}
}