123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154 |
- using System;
- using System.IO;
- using System.Net;
- using System.Text;
- namespace OSHttpServer
- {
- /// <summary>
- /// Response that is sent back to the web browser / client.
- ///
- /// A response can be sent if different ways. The easiest one is
- /// to just fill the Body stream with content, everything else
- /// will then be taken care of by the framework. The default content-type
- /// is text/html, you should change it if you send anything else.
- ///
- /// The second and slighty more complex way is to send the response
- /// as parts. Start with sending the header using the SendHeaders method and
- /// then you can send the body using SendBody method, but do not forget
- /// to set ContentType and ContentLength before doing so.
- /// </summary>
- /// <example>
- /// public void MyHandler(IHttpRequest request, IHttpResponse response)
- /// {
- ///
- /// }
- /// </example>
- public interface IHttpResponse
- {
- /// <summary>
- /// The body stream is used to cache the body contents
- /// before sending everything to the client. It's the simplest
- /// way to serve documents.
- /// </summary>
- ///
- Stream Body { get; }
- byte[] RawBuffer { get; set; }
- int RawBufferStart { get; set; }
- int RawBufferLen { get; set; }
- uint requestID { get; }
- double RequestTS { get;}
- /// <summary>
- /// Defines the version of the HTTP Response for applications where it's required
- /// for this to be forced.
- /// </summary>
- string ProtocolVersion { get; set; }
- int Priority { get; set; }
- /// <summary>
- /// The chunked encoding modifies the body of a message in order to
- /// transfer it as a series of chunks, each with its own size indicator,
- /// followed by an OPTIONAL trailer containing entity-header fields. This
- /// allows dynamically produced content to be transferred along with the
- /// information necessary for the recipient to verify that it has
- /// received the full message.
- /// </summary>
- bool Chunked { get; set; }
- /// <summary>
- /// Kind of connection
- /// </summary>
- ConnectionType Connection { get; set; }
- /// <summary>
- /// Encoding to use when sending stuff to the client.
- /// </summary>
- /// <remarks>Default is UTF8</remarks>
- Encoding Encoding { get; set; }
- /// <summary>
- /// Number of seconds to keep connection alive
- /// </summary>
- /// <remarks>Only used if Connection property is set to ConnectionType.KeepAlive</remarks>
- int KeepAlive { get; set; }
- /// <summary>
- /// Status code that is sent to the client.
- /// </summary>
- /// <remarks>Default is HttpStatusCode.Ok</remarks>
- HttpStatusCode Status { get; set; }
- /// <summary>
- /// Information about why a specific status code was used.
- /// </summary>
- string Reason { get; set; }
- /// <summary>
- /// Size of the body. MUST be specified before sending the header,
- /// unless property Chunked is set to true.
- /// </summary>
- long ContentLength { get; set; }
- /// <summary>
- /// Kind of content in the body
- /// </summary>
- /// <remarks>Default is text/html</remarks>
- string ContentType { get; set; }
- /// <summary>
- /// Headers have been sent to the client-
- /// </summary>
- /// <remarks>You can not send any additional headers if they have already been sent.</remarks>
- bool HeadersSent { get; }
- /// <summary>
- /// The whole response have been sent.
- /// </summary>
- bool Sent { get; }
- /// <summary>
- /// Cookies that should be created/changed.
- /// </summary>
- ResponseCookies Cookies { get; }
- /// <summary>
- /// Set response as a http redirect
- /// </summary>
- /// <param name="url">redirection target url</param>
- /// <param name="redirStatusCode">the response Status, must be Found, Redirect, Moved,MovedPermanently,RedirectKeepVerb, RedirectMethod, TemporaryRedirect. Defaults to Redirect</param>
- void Redirect(string url, HttpStatusCode redirStatusCode = HttpStatusCode.Redirect);
- /// <summary>
- /// Add another header to the document.
- /// </summary>
- /// <param name="name">Name of the header, case sensitive, use lower cases.</param>
- /// <param name="value">Header values can span over multiple lines as long as each line starts with a white space. New line chars should be \r\n</param>
- /// <exception cref="InvalidOperationException">If headers already been sent.</exception>
- /// <exception cref="ArgumentException">If value conditions have not been met.</exception>
- /// <remarks>Adding any header will override the default ones and those specified by properties.</remarks>
- void AddHeader(string name, string value);
- /// <summary>
- /// Send headers and body to the browser.
- /// </summary>
- /// <exception cref="InvalidOperationException">If content have already been sent.</exception>
- void Send();
- }
- /// <summary>
- /// Type of HTTP connection
- /// </summary>
- public enum ConnectionType
- {
- /// <summary>
- /// Connection is closed after each request-response
- /// </summary>
- Close,
- /// <summary>
- /// Connection is kept alive for X seconds (unless another request have been made)
- /// </summary>
- KeepAlive
- }
- }
|