<?xml version="1.0"?>
<doc>
<assembly>
<name>InsomniaServer</name>
</assembly>
<members>
<member name="T:InsomniaSoftware.Server.HttpRequest">
<summary>
HTTP request class
Manages requests and sends responses
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.headerReceiveBufferSize">
<summary>
Request header receive buffer size
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.contentReceiveBufferSize">
<summary>
Request body receive buffer size
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.maxContentInRamSize">
<summary>
Maximal request body size which is saved in RAM
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.minReadBufferSize">
<summary>
Minimal response body read buffer size
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.maxReadBufferSize">
<summary>
Maximal response body read buffer size
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.contentBoundary">
<summary>
String that seperates parts of the content - if existing
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.statusCodePhrases">
<summary>
Some phrases describing the HTTP status codes
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.#ctor(InsomniaSoftware.Server.HttpConnection,System.Int32)">
<summary>
Default constructor
</summary>
<param name="connection">New request's connection</param>
<param name="requestId">The new request's id (set by HttpConnection)</param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.Finalize">
<summary>
HttpRequest destructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.Handle">
<summary>
Processes the request - receives header / content - and responds
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.ReceiveHeaderCallback(System.IAsyncResult)">
<summary>
Callback for received request header chunks
</summary>
<param name="result"></param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.ReceiveContentCallback(System.IAsyncResult)">
<summary>
Callback for received request content chunks
</summary>
<param name="result"></param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.ParseHTTPHeader">
<summary>
Parses the request's HTTP header
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.ExtractParameters">
<summary>
Processes/Extracts all parameters belonging to this request
</summary>
</member>
<!-- Badly formed XML comment ignored for member "M:InsomniaSoftware.Server.HttpRequest.ExtractParametersFromRaw(System.String,InsomniaSoftware.Server.ParameterSource,System.Text.Encoding)" -->
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameter(System.String)">
<summary>
Gets a parameter's value
</summary>
<param name="parameterName">Parameter's name</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameterAsString(System.String)">
<summary>
Gets a parameter's value as StringParameter - value is raw
</summary>
<param name="parameterName">Parameter's name</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameterAsString(System.String,System.Text.Encoding)">
<summary>
Gets a parameter's value as StringParameter - value is decoded using a given encoding
</summary>
<param name="parameterName">Parameter's name</param>
<param name="encoding">Encoding to be used to decode this parameter's value</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameterAsInt(System.String)">
<summary>
Gets a parameter's value as IntParameter
</summary>
<param name="parameterName">Parameter's name</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameterAsFloat(System.String)">
<summary>
Gets a parameter's value as FloatParameter
</summary>
<param name="parameterName">Parameter's name</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetParameterAsBinary(System.String)">
<summary>
Gets a parameter's value as BinaryParameter
</summary>
<param name="parameterName">Parameter's name</param>
<returns>The parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeeded">
<summary>
Checks whether the response source has to render its content
</summary>
<returns>ResponseBodyNeed enum value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeeded(System.DateTime)">
<summary>
Checks whether the response source has to render its content
</summary>
<param name="lastModificationTime">Time at which the response data was modified last</param>
<returns>ResponseBodyNeed enum value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeeded(System.String)">
<summary>
Checks whether the response source has to render its content
</summary>
<param name="eTag">The tag (eTag) string of the response data which the client already has</param>
<returns>ResponseBodyNeed enum value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeeded(System.DateTime,System.String)">
<summary>
Checks whether the response source has to render its content
</summary>
<param name="lastModificationTime">Time at which the response data was modified last</param>
<param name="eTag">The tag (eTag) string of the response data which the client already has</param>
<returns>ResponseBodyNeed enum value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeededTryGetSource(InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed,InsomniaSoftware.Server.ContentType,System.Int32,InsomniaSoftware.Server.Sources.SourceInfo,InsomniaSoftware.Server.Sources.Source@)">
<summary>
Tries to get a source responding automatically to a request (only possible if the full source was sent at least once)
</summary>
<param name="responseBodyNeed">Return value of IsResponseBodyNeeded</param>
<param name="contentType">Content type for the possible response</param>
<param name="contentLength">Content length for the possible response</param>
<param name="sourceInfo">SourceInfo for the possible response</param>
<param name="source">If a source was created, a handle to the created source (return value = true). Null if none was created (return value = false.</param>
<returns>True if the function succeeded in creating a response, false if not.</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.IsResponseBodyNeededTryGetSource(InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed,InsomniaSoftware.Server.ContentType,System.Int32,InsomniaSoftware.Server.HttpStatus,InsomniaSoftware.Server.Sources.Source@)">
<summary>
Tries to get a source responding automatically to a request (only possible if the full source was sent at least once)
</summary>
<param name="responseBodyNeed">Return value of IsResponseBodyNeeded</param>
<param name="contentType">Content type for the possible response</param>
<param name="contentLength">Content length for the possible response</param>
<param name="status">Status for the possible response</param>
<param name="source">If a source was created, a handle to the created source (return value = true). Null if none was created (return value = false.</param>
<returns>True if the function succeeded in creating a response, false if not.</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.Respond(System.Object)">
<summary>
Send response for this request to the client
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.SendSourceContent(InsomniaSoftware.Server.Sources.Source)">
<summary>
Sends the source's content to the client
</summary>
<param name="source">Source to be sent</param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.SendHeaderCallback(System.IAsyncResult)">
<summary>
Callback for sent response header chunks
</summary>
<param name="result"></param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.SendContentCallback(System.IAsyncResult)">
<summary>
Callback for sent response content chunks
</summary>
<param name="result"></param>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.HandleSocketException(System.Exception)">
<summary>
Processes exceptions thrown by socket functions
</summary>
<param name="e">The exception</param>
<returns>Abort request's handling?</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.HandleSocketException(System.Exception,InsomniaSoftware.Server.Sources.Source)">
<summary>
Processes exceptions thrown by socket functions
</summary>
<param name="e">The exception</param>
<param name="source">Currently processed source</param>
<returns>Abort request's handling?</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpRequest.GetStatusCodePhrase(System.Int32)">
<summary>
Get status phrase for the passed code
</summary>
<param name="statusCode">Status code</param>
<returns>Describing phrase</returns>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.server">
<summary>
Handle to belonging InsomniaServer instance
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.connection">
<summary>
Handle to the belonging HttpConnection
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.id">
<summary>
The request's id
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.localEndPoint">
<summary>
Local (server's) end point (ip / port)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.remoteEndPoint">
<summary>
Client's end point (ip / port)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.httpHeader">
<summary>
The request's plain HTTP header
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.method">
<summary>
The request's method
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.contentStream">
<summary>
Stream containing the request's body - if there is one (POST and PUT method)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.contentType">
<summary>
Content type of the request's body - if existing
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.contentCharset">
<summary>
Content's charset (encoding)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.requestedURL">
<summary>
The requested URL
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.rawQueryString">
<summary>
Received "GET parameters" --> parameters from the transferred url
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.parameters">
<summary>
Received parameters (from url and request body)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.sourceNode">
<summary>
Node which contains the response source
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.protocolVersion">
<summary>
The request's HTTP protocol version
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.host">
<summary>
Host to which the message was sent
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.userAgent">
<summary>
User agent (browser etc.) the request was sent from
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.connectionType">
<summary>
Defines whether the connection should be closed after responding to this request or not
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.acceptedCharsets">
<summary>
Array of weighted entries holding the encodings accepted by the client
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.requestedByteRanges">
<summary>
Byte ranges which are requested by the client
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.ifModifiedSince">
<summary>
Gets the "if-modified-since" header value if there is one
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.ifUnmodifiedSince">
<summary>
Gets the "if-unmodified-since" header value if there is one
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.ifMatchTag">
<summary>
Gets the "if-match" header value if there is one
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpRequest.ifNoneMatchTag">
<summary>
Gets the "if-none-match" header value if there is one
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpRequest.ReceiveHttpBodyData">
<summary>
Structure carrying buffer and status variables while receiving the http body
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpRequest.SendResponseData">
<summary>
Structure carrying the response's send state variables
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed">
<summary>
Specifies whether it is neccessary for a source to create its body
If value is above zero body is needed, if below it is unnecessary
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed.Necessary">
<summary>
Response body creation necessary
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed.Unnecessary_NotModified">
<summary>
Response body creation unnecessary as the client already has a up to date version of the content
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed.Unnecessary_Head">
<summary>
Response body creation unnecessary as the client used the HEAD
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed.Unnecessary_TagsEqual">
<summary>
Response body creation unnecessary as the client already has a version with that eTag
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpRequest.ResponseBodyNeed.Unnecessary_NotModified_TagsEqual">
<summary>
Response body creation unnecessary as the client already has a version with that eTag which is up to date
</summary>
</member>
<member name="T:InsomniaSoftware.Server.WeightedHeaderEntry`1">
<summary>
Class carrying a weighted header entry
e.g.: someVal;q=0.8
</summary>
<typeparam name="Type"></typeparam>
</member>
<member name="F:InsomniaSoftware.Server.WeightedHeaderEntry`1.userData">
<summary>
Processed version of the entry's content
</summary>
</member>
<member name="M:InsomniaSoftware.Server.WeightedHeaderEntry`1.#ctor(System.String)">
<summary>
Constructor - initializes a new weighted header entry
</summary>
<param name="rawEntry">Raw version of the entry. E.g. EN-en;q=0.5</param>
</member>
<member name="P:InsomniaSoftware.Server.WeightedHeaderEntry`1.entry">
<summary>
The entry
</summary>
</member>
<member name="P:InsomniaSoftware.Server.WeightedHeaderEntry`1.weight">
<summary>
The entry's weight between 0.0 and 1.0
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpMethod">
<summary>
HTTP method enumeration
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Unknown">
<summary>
Method is unknown
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Get">
<summary>
Method GET
Server is asked to send something
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Head">
<summary>
Method HEAD
Server is asked to just send the header of the response
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Post">
<summary>
Method POST
Data is sent to the server
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Put">
<summary>
Method PUT
Client tries to put a file onto the server
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Trace">
<summary>
Method TRACE
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Options">
<summary>
Method OPTIONS
Client askes for the server's capabilities
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpMethod.Delete">
<summary>
Method DELETE
Client tries to delete a file on the server
</summary>
</member>
<member name="T:InsomniaSoftware.Server.ConnectionType">
<summary>
Type of the desired connection
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ConnectionType.Unknown">
<summary>
Connection type is unknown
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ConnectionType.Close">
<summary>
Connection is to be closed after responding to this request
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ConnectionType.KeepAlive">
<summary>
Connection should be kept alive
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpStatus">
<summary>
Http status code enumeration
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.OK">
<summary>
Everything is okay
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.NoContent">
<summary>
Okay, but the response has no content (body)
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.PartialContent">
<summary>
Okay. Response is send partial only
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.MovedPermanently">
<summary>
The request's destination has moved permanently
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.NotModified">
<summary>
Response content has not changed and is not sent again
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.Unauthorized">
<summary>
Request has not been authorised
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.UnauthorizedStillRespond">
<summary>
Request has not been authorised but the response is still sent
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.Forbidden">
<summary>
Access is forbidden
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.ForbiddenStillRespond">
<summary>
Access is forbidden but the response is still sent
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.NotFound">
<summary>
Object has not been found on the server
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.NotFoundStillRespond">
<summary>
Object has not been found on the server but the response is still sent
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.InternalError">
<summary>
An internal error has occured
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatus.InternalErrorStillRespond">
<summary>
An internal error has occured but the response is still sent
</summary>
</member>
<member name="T:InsomniaSoftware.Server.HttpVersion">
<summary>
Structure holding a HTTP protocol version
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpVersion.majorVer">
<summary>
Major part
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpVersion.minorVer">
<summary>
Minor part
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpVersion.ToString">
<summary>
Returns the http version as a string (e.g. "1.1")
</summary>
<returns>Http version string</returns>
</member>
<member name="T:InsomniaSoftware.Server.HttpStatusCodePhrase">
<summary>
Structure holding a HTTP status code and the belonging phrase
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatusCodePhrase.code">
<summary>
Status code
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpStatusCodePhrase.phrase">
<summary>
Belonging phrase
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpStatusCodePhrase.#ctor(System.Int32,System.String)">
<summary>
Constructor
</summary>
<param name="code">Status code</param>
<param name="phrase">Status phrase</param>
</member>
<member name="T:InsomniaSoftware.Server.ContentType">
<summary>
Represents a MIME content type
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.contentTypeMIMEs">
<summary>
MIME type names
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.registeredFileExtensions">
<summary>
File extensions and belonging MIME types
</summary>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.FromMIME(System.String)">
<summary>
Creates a new ContentType instance from a given MIME string
</summary>
<param name="mime">MIME string</param>
<returns>The created ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.FromType(InsomniaSoftware.Server.ContentType.Type)">
<summary>
Creates a new ContentType instance from a given type
</summary>
<param name="type">Type of the content</param>
<returns>The created ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.FromExtension(System.String)">
<summary>
Creates a new ContentType instance from a given file extension
</summary>
<param name="extension">Extension (including or excluding the seperating '.'</param>
<returns>The created ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.FromFileName(System.String)">
<summary>
Creates a new ContentType instance from a given file name
</summary>
<param name="fileName">Name of the file of which the content type is to be created</param>
<returns>The created ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.Equals(System.Object)">
<summary>
Checks whether two ContentType instances represent the same MIME string
</summary>
<param name="obj">ContentType instance to be checked against this one</param>
<returns>True if the instances are equal, false if not</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.GetHashCode">
<summary>
Gets a hash code for this ContentType
</summary>
<returns>Hash code</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.op_Equality(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.ContentType)">
<summary>
Equality operator
</summary>
<param name="t1">ContentType instance 1</param>
<param name="t2">ContentType instance 2</param>
<returns>True, if equal. False, if not</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.op_Equality(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.ContentType.Type)">
<summary>
Equality operator
</summary>
<param name="t1">ContentType instance 1</param>
<param name="t2">Type of instance 2</param>
<returns>True, if equal. False, if not</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.op_Inequality(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.ContentType)">
<summary>
Inequality operator
</summary>
<param name="t1">ContentType instance 1</param>
<param name="t2">ContentType instance 2</param>
<returns>True, if not equal. False, if equal</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.op_Inequality(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.ContentType.Type)">
<summary>
Inequality operator
</summary>
<param name="t1">ContentType instance 1</param>
<param name="t2">Type of instance 2</param>
<returns>True, if not equal. False, if equal</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.GetMime">
<summary>
Gets the MIME string of this ContentType
</summary>
<returns>MIME string</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.GetContentTypeMIME(InsomniaSoftware.Server.ContentType.Type)">
<summary>
Get content type's name
</summary>
<param name="type">Content type</param>
<returns>Belonging name</returns>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.LoadDefaultFileExtensions">
<summary>
Loads default extensions and their belonging types
</summary>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.LoadFileExtensionsFromFile(System.String)">
<summary>
Loads a set of extensions and their belonging types from a specified file<br/><br/>
<i>This file is formatted as follows:<br/>
txt text/plain<br/>
html,htm text/html</i>
</summary>
<param name="filePath"></param>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.AddFileExtension(System.String,System.String)">
<summary>
Adds a new file extension and its belonging MIME type
</summary>
<param name="extension"></param>
<param name="mime"></param>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.ClearFileExtensions">
<summary>
Clears all file extensions
</summary>
</member>
<member name="T:InsomniaSoftware.Server.ContentType.HttpContentTypeMIME">
<summary>
Structure holding a content type and its name
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.HttpContentTypeMIME.type">
<summary>
Content type
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.HttpContentTypeMIME.name">
<summary>
Type name
</summary>
</member>
<member name="M:InsomniaSoftware.Server.ContentType.HttpContentTypeMIME.#ctor(InsomniaSoftware.Server.ContentType.Type,System.String)">
<summary>
Constructor
</summary>
<param name="type">Content type</param>
<param name="name">Content type's name</param>
</member>
<member name="T:InsomniaSoftware.Server.ContentType.Type">
<summary>
Content type enumeration
Needed to tell the client which type of data is sent -> MIME
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Plain">
<summary>
Plain text
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Html">
<summary>
Html pages
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Css">
<summary>
Style sheet documents
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.RichText">
<summary>
Rich text documents
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Xml">
<summary>
Xml documents
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Pdf">
<summary>
PDF documents
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Binary">
<summary>
Binary data
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Jpeg">
<summary>
Jpeg images
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Gif">
<summary>
Gif images
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Png">
<summary>
Png images
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Tiff">
<summary>
Tiff images
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Bmp">
<summary>
Bmp images
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Midi">
<summary>
Midi audio files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Mp3">
<summary>
MP2, MP3 audio files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.RealAudio">
<summary>
RealAudio files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Wav">
<summary>
Wave audio files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Mpeg">
<summary>
MPEG videos
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.QuickTime">
<summary>
MOV videos
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Avi">
<summary>
AVI videos
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.RealMedia">
<summary>
RealMedia files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.ShockWave">
<summary>
Macromedia Flash files
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.FormData">
<summary>
Multipart type containing a filled-out form's data
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ContentType.Type.Mixed">
<summary>
Multipart type containing not further specified data
</summary>
</member>
<member name="T:InsomniaSoftware.Server.FileSystem">
<summary>
Class holding the server's file system and holding the root of all "FSNode"s
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FileSystem.GetNode(System.String)">
<summary>
Get the node having the passed path
</summary>
<param name="path">Demanded node's path</param>
<returns>Found node</returns>
</member>
<member name="M:InsomniaSoftware.Server.FileSystem.CreateNode(System.String)">
<summary>
Create a node having the passed path
</summary>
<param name="path">Path to be created</param>
<returns>The created node</returns>
</member>
<member name="M:InsomniaSoftware.Server.FileSystem.AddSource(System.String,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Adds a source to the file system
</summary>
<param name="path">Path and name of the source<br/>
Remember to specify '*' as name for sources containing more than one file name.</param>
<param name="callback">Source's callback</param>
<param name="userData">UserData to be passed to the callback</param>
</member>
<member name="M:InsomniaSoftware.Server.FileSystem.RemoveSource(System.String)">
<summary>
Removes a source from the file system<br/>
<i>Not working for sources named '*'</i>
</summary>
<param name="path">The source's path</param>
</member>
<member name="M:InsomniaSoftware.Server.FileSystem.RemoveSource(System.String,System.Type,System.Object)">
<summary>
Removes the source having the specified callback and user data
</summary>
<param name="path">Path of the source</param>
<param name="callbackType">The source's callback</param>
<param name="userData">Callback's user data</param>
</member>
<member name="P:InsomniaSoftware.Server.FileSystem.root">
<summary>
File system's node root
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.DirectorySource">
<summary>
Contains the GetSource callback for adding a whole-directory source and the DirectorySource class which has to be passed to this callback
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.DirectorySource.#ctor(System.String)">
<summary>
Creates a DirectorySource instance for the passed path and all sub directories
</summary>
<param name="localDirectoryPath">Path of the source's directory</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.DirectorySource.#ctor(System.String,System.Boolean)">
<summary>
Creates a DirectorySource instance for the passed path
</summary>
<param name="localDirectoryPath">Path of the source's directory</param>
<param name="includeSubDirectories">Specifies whether sub directories are to be included in this source</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.DirectorySource.#ctor(System.String,System.Boolean,System.Text.RegularExpressions.Regex)">
<summary>
Creates a DirectorySource instance for the passed path
</summary>
<param name="localDirectoryPath">Path of the source's directory</param>
<param name="includeSubDirectories">Specifies whether sub directories are to be included in this source</param>
<param name="filter">Sets a filter regular expression which is tested against all requests (respectively their sub paths)</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.DirectorySource.GetSource(System.String,InsomniaSoftware.Server.HttpRequest,System.Object,InsomniaSoftware.Server.Sources.Source@)">
<summary>
GetSource callback for direct insertion to FSNode.AddSource<br/>
<i>Remember to set '*' as the source's name</i>
</summary>
<param name="subPath">Sub path of the requested object</param>
<param name="request">The belonging HttpRequest</param>
<param name="directorySource">Handle to the belonging DirectorySource instance</param>
<param name="source">Out parameter: source</param>
<returns>ObjectType.File if the file was opened properly, ObjectType.NotFound if not and ObjectType.Folder if the object is a folder</returns>
</member>
<member name="T:InsomniaSoftware.Server.Tools.GeneralTools">
<summary>
Provides static methods for common needed tasks
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Tools.GeneralTools.HexToDec(System.String)">
<summary>
Converts a hexadecimal value into a decimal one
</summary>
<param name="hexValue">String containing the hex value (e.g. "e3")</param>
<returns>The belonging decimal value</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.GeneralTools.DecToHex(System.Int32)">
<summary>
Converts decimal into hexadecimal values
</summary>
<param name="decValue">Decimal value to be converted</param>
<returns>Hexadecimal string (e.g. "a2")</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.GeneralTools.DatesEqual(System.DateTime,System.DateTime)">
<summary>
Tests whether to dates are equal
</summary>
<param name="d1">First date to be compared</param>
<param name="d2">Second date to be compared</param>
<returns>Equal?</returns>
</member>
<member name="T:InsomniaSoftware.Server.Tools.Range">
<summary>
Provides a structure to hold a range (from - to)
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Tools.Range.first">
<summary>
First value
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Tools.Range.last">
<summary>
Last value
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Tools.Range.#ctor(System.Int32,System.Int32)">
<summary>
Range constructor
</summary>
<param name="first">First (min) value</param>
<param name="last">Last (max) value</param>
</member>
<member name="T:InsomniaSoftware.Server.Sources.StreamSource">
<summary>
Represents a source which is able to send a stream to the client
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.Source">
<summary>
Abstract base class for a source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.Dispose">
<summary>
Disposes the source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.GetLength">
<summary>
Gets the length of the source's content
</summary>
<returns>Content length</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Moves current the position withing the source
</summary>
<param name="offset">Offset by which the location will move</param>
<param name="origin">Position to start moving at</param>
<returns>The absolute position within the data</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Reads a specified number of bytes into the given buffer
</summary>
<param name="buffer">Buffer to be filled</param>
<param name="offset">First position in the buffer to be filled</param>
<param name="count">Number of bytes to be read</param>
<returns>The actual number of bytes read</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.ReadByte">
<summary>
Reads the next byte without advancing
</summary>
<returns></returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.GetContentType">
<summary>
Gets the content type of this source's content
</summary>
<returns>ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.Source.GetInformation">
<summary>
Gets the SourceInfo
</summary>
<returns>SourceInfo of this Source</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.#ctor(System.IO.Stream,InsomniaSoftware.Server.ContentType,System.Boolean)">
<summary>
Creates a new StreamSource instance
</summary>
<param name="stream">Stream to be sent to the client</param>
<param name="contentType">ContentType of the data within the stream</param>
<param name="closeAfterRequest">If true, the stream is disposed after the end of this request</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.#ctor(System.IO.Stream,InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.Sources.SourceInfo,System.Boolean)">
<summary>
Creates a new StreamSource instance
</summary>
<param name="stream">Stream to be sent to the client</param>
<param name="contentType">ContentType of the data within the stream</param>
<param name="info">SourceInfo for this source</param>
/// <param name="closeAfterRequest">If true, the stream is disposed after the end of this request</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.Finalize">
<summary>
Destructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.Dispose">
<summary>
Disposes the StreamSource
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.GetLength">
<summary>
Gets the length of the source's content
</summary>
<returns>Content length</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Moves current the position withing the binary data
</summary>
<param name="offset">Offset by which the location will move</param>
<param name="origin">Position to start moving at</param>
<returns>The absolute position within the data</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Reads a specified number of bytes into the given buffer
</summary>
<param name="buffer">Buffer to be filled</param>
<param name="offset">First position in the buffer to be filled</param>
<param name="count">Number of bytes to be read</param>
<returns>The actual number of bytes read</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.GetContentType">
<summary>
Gets the content type of this source's content
</summary>
<returns>ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.StreamSource.GetInformation">
<summary>
Gets the SourceInfo
</summary>
<returns>SourceInfo of this StreamSource</returns>
</member>
<member name="T:InsomniaSoftware.Server.SessionManager">
<summary>
The SessionManager stores sessions and key/value paires assigned to them
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SessionManager.sessionLifetime">
<summary>
Time in seconds after which a unused session is removed
</summary>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.Finalize">
<summary>
Destructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.GetEnumerator">
<summary>
Gets a enumerator for all sessions
</summary>
<returns>IEnumerator which enumerates all sessions</returns>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.RegisterSession(InsomniaSoftware.Server.Session)">
<summary>
Registers a new session with the manager
</summary>
<param name="session">Session handle</param>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.RegisterSession(System.String)">
<summary>
Creates and registers a new session
</summary>
<param name="id">ID that the new session shall have</param>
<returns>The created session</returns>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.RegisterSession">
<summary>
/// Creates and registers a new session with a random id
</summary>
<returns>The created session</returns>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.UnregisterSession(InsomniaSoftware.Server.Session)">
<summary>
Unregisters the given session
</summary>
<param name="session">Session handle</param>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.UnregisterSession(System.String)">
<summary>
Unregisters the given session
</summary>
<param name="id">Session id</param>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.GetSession(System.String,System.Boolean)">
<summary>
Gets the session having the passed id
</summary>
<param name="id">Session id</param>
<param name="createIfNotExisting">Specifies whether the session is to be created if not existing</param>
<returns>The requested session</returns>
</member>
<member name="M:InsomniaSoftware.Server.SessionManager.GetSession(System.String)">
<summary>
Gets the session having the passed id
</summary>
<param name="id">Session id</param>
<returns>The requested session</returns>
</member>
<member name="T:InsomniaSoftware.Server.Session">
<summary>
Holds a session's data
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Session.lastAccess">
<summary>
Last time the session was accessed
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Session.#ctor(System.String)">
<summary>
Session constructor
Remember to register the session with the session manager
</summary>
<param name="id">The new session's id</param>
</member>
<member name="M:InsomniaSoftware.Server.Session.SetValue(System.String,System.Object)">
<summary>
Sets a key/value pair in this session
</summary>
<param name="varName">Key name</param>
<param name="value">Value</param>
</member>
<member name="M:InsomniaSoftware.Server.Session.SetStringValue(System.String,System.String)">
<summary>
Sets a key/value string pair in this session
</summary>
<param name="varName">Key name</param>
<param name="value">Value string</param>
</member>
<member name="M:InsomniaSoftware.Server.Session.GetValue(System.String)">
<summary>
Gets a key's value
</summary>
<param name="varName">Key name</param>
<returns>The key's value if found, null if not</returns>
</member>
<member name="M:InsomniaSoftware.Server.Session.GetStringValue(System.String)">
<summary>
Gets a string key's value
</summary>
<param name="varName">Key name</param>
<returns>The key's value if found, null if not</returns>
</member>
<member name="P:InsomniaSoftware.Server.Session.id">
<summary>
The session's id
</summary>
</member>
<member name="E:InsomniaSoftware.Server.Session.OnDispose">
<summary>
Event, which is to be fired, when this session is to be disposed
</summary>
</member>
<member name="T:InsomniaSoftware.Server.DisposeSessionDelegate">
<summary>
A delegate for a funtion, which disposes a session
</summary>
<param name="sessionToDispose">Session, of which the content is to be disposed</param>
</member>
<member name="T:InsomniaSoftware.Server.FSNode">
<summary>
Represents a single node within the file system
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.CreateSubNode(System.String)">
<summary>
Creates a node
</summary>
<param name="path">Path of the node to be created</param>
<returns>Handle to the new node</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSubNode(System.String)">
<summary>
Gets a sub node
</summary>
<param name="path">Path of the node</param>
<returns>The node's handle or null if not found</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSomeSubNode(System.String)">
<summary>
Gets the sub node which fits the passed path best<br/>
This can be the requested node or some parent node of it (if it does not exist).
</summary>
<param name="path">Path of the node</param>
<returns>A node's handle or null if some error occurred</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.AddSource(System.String,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Adds a new source to this node
</summary>
<param name="name">The new source's name<br/>
Remember to specify '*' as name for sources containing more than one file name.</param>
<param name="callback">Source's callback</param>
<param name="userData">UserData to be passed to the callback</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.RemoveSource(System.String)">
<summary>
Removes a source<br/>
<i>Not working for sources named '*'</i>
</summary>
<param name="name">The source's name</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.RemoveSource(System.Type,System.Object)">
<summary>
Removes the source having the specified callback and user data
</summary>
<param name="callbackType">The source's callback</param>
<param name="userData">Callback's user data</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSource(InsomniaSoftware.Server.HttpRequest,System.String,InsomniaSoftware.Server.FSNode@)">
<summary>
Gets a Source
</summary>
<param name="request">Belonging HttpRequest or null (if url != null)</param>
<param name="url">Requested URL or null (if request != null)</param>
<param name="mostSuitingNode">Reference parameter which is set to the best fitting node for this request</param>
<returns>The requested Source</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.RedirectRequestToFolder(InsomniaSoftware.Server.HttpRequest,System.String)">
<summary>
Redirects "wrong" requests
e.g. page/directory
-> page/directory/
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSource(InsomniaSoftware.Server.HttpRequest,InsomniaSoftware.Server.FSNode@)">
<summary>
Gets a Source
</summary>
<param name="request">The belonging HttpRequest</param>
<param name="mostSuitingNode">Reference parameter which is set to the best fitting node for this request</param>
<returns>The requested Source</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSource(InsomniaSoftware.Server.HttpRequest)">
<summary>
Gets a Source
</summary>
<param name="request">The belonging HttpRequest</param>
<returns>The requested Source</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SetErrorSource(System.Int32,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Sets an error source for this node
</summary>
<param name="statusCode">The status code for which this error source is responsible</param>
<param name="callback">The source's callback</param>
<param name="userData">UserData to be passed to the callback</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SetErrorSource(System.Int32,System.String)">
<summary>
Sets an error page for this node
</summary>
<param name="statusCode">The status code for which this error page is responsible</param>
<param name="errorPagePath">Local path of the error page file</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetErrorSource(InsomniaSoftware.Server.HttpRequest,System.Int32)">
<summary>
Gets an error source
</summary>
<param name="request">The belonging request</param>
<param name="statusCode">Status/error code</param>
<returns>The requested Source</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SetSecurityValidator(InsomniaSoftware.Server.SecurityValidatorDelegate,System.Object,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Sets a security-validating function which is run anytime a source of this node is requested
</summary>
<param name="validator">The validator function</param>
<param name="validatorUserData">User defined value to be passed to the validator function</param>
<param name="unauthorizedPage">Get source funtion of the source to be sent if the request did not pass the test</param>
<param name="unauthorizedPageUserData">User defined value to be passed to the GetSource function of the unauthorizedPage</param>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SetEmptySecurityValidator">
<summary>
Sets an empty (always acquiescing) security validator
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SetInheritedSecurityValidator">
<summary>
Security validator shall be inherited from the next parent node having one
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.GetSecurityValidator">
<summary>
Gets the security validator descriptor responsible for this node (maybe an inherited one)
</summary>
<returns>The SecurityValidatorDescriptor</returns>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.DoSecurityValidation(System.String,InsomniaSoftware.Server.HttpRequest,InsomniaSoftware.Server.Sources.GetSourceCallback@,System.Object@)">
<summary>
Validates the security of the passed request
</summary>
<param name="subPath">Requested object's sub path</param>
<param name="request">The request</param>
<param name="getSourceCallback">The get source callback - set to the validation failed callback if that is the case</param>
<param name="getSourceUserData">The get source user defined value - set to the validation failed user data if that is the case</param>
<returns>Did the validation succeed?</returns>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.name">
<summary>
Gets or sets node's name
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.parent">
<summary>
Gets or sets the node's parent
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.path">
<summary>
Gets the node's path
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.nodes">
<summary>
Gets all sub nodes
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.sources">
<summary>
Gets all sources contained in this node
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.defaultPage">
<summary>
Gets or sets the default page<br/>
Specify multiple default pages seperated by spaces (e.g. "index.html index.htm mypage.html")
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FSNode.defaultEncoding">
<summary>
Encoding which is to be used by this node's sources by default
If you set this to 'null', the parent's encoding will be used
</summary>
</member>
<member name="T:InsomniaSoftware.Server.FSNode.SourceEntry">
<summary>
Represents a source entry within a node
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.SourceEntry.name">
<summary>
The entry's name
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.SourceEntry.callback">
<summary>
Entry's callback
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.SourceEntry.userData">
<summary>
User data to be passed to the callback
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.SourceEntry.#ctor(System.String,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Constructor
</summary>
<param name="name">The entry's name</param>
<param name="callback">Entry's callback</param>
<param name="userData">User data to be passed to the callback</param>
</member>
<member name="T:InsomniaSoftware.Server.FSNode.ErrorSourceEntry">
<summary>
Represents an error source entry within a node
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.ErrorSourceEntry.code">
<summary>
The belonging status code
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.ErrorSourceEntry.callback">
<summary>
Entry's callback
</summary>
</member>
<member name="F:InsomniaSoftware.Server.FSNode.ErrorSourceEntry.userData">
<summary>
User data to be passed to the callback
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FSNode.ErrorSourceEntry.#ctor(System.Int32,InsomniaSoftware.Server.Sources.GetSourceCallback,System.Object)">
<summary>
Constructor
</summary>
<param name="code">The belonging status code</param>
<param name="callback">Entry's callback</param>
<param name="userData">User data to be passed to the callback</param>
</member>
<member name="T:InsomniaSoftware.Server.SecurityValidatorDescriptor">
<summary>
Represents the description of a security validator
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SecurityValidatorDescriptor.validatorCallback">
<summary>
The validator's callback
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SecurityValidatorDescriptor.validatorUserData">
<summary>
User defined value which is passed to the validator
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SecurityValidatorDescriptor.validationFailedSourceCallback">
<summary>
Source callback which is called on verification failures
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SecurityValidatorDescriptor.validationFailedSourceUserData">
<summary>
User defined value which is passed to the failure source callback
</summary>
</member>
<member name="T:InsomniaSoftware.Server.SecurityValidatorDelegate">
<summary>
Delegate for a function to validate whether a request passes possible security tests
</summary>
/// <param name="validatorUserData">User defined value which is passed to the validator</param>
<param name="subPath">Source's sub path</param>
<param name="request">Belonging request</param>
<param name="sourceUserData">User defined value which is passed to the source</param>
<returns>True if the request passed the test, false if not</returns>
</member>
<member name="T:InsomniaSoftware.Server.Sources.HtmlSource">
<summary>
A source which enables you to construct html structures. The final html source is build by this class.
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.HtmlSource.curNode">
<summary>
Gets/sets the node which has been added most recently. curNode is very useful to build complex page structures without saving every node handle. Call MoveCurNodeLevelUp() to go to its parent.
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.#ctor(System.String)">
<summary>
Initializes a new HtmlSource
</summary>
<param name="pageTitle">Title of the page to be created</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.#ctor(System.String,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Initializes a new HtmlSource
</summary>
<param name="pageTitle">Title of the page to be created</param>
<param name="sourceInfo">SourceInfo for this source</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.BuildDataStream">
<summary>
Rebuilds the data stream if necessarry
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.MoveCurNodeLevelUp">
<summary>
Sets the curNode handle to its parent node
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.GetLength">
<summary>
Gets the length of the source's content
</summary>
<returns>Content length</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Moves current the position withing the binary data
</summary>
<param name="offset">Offset by which the location will move</param>
<param name="origin">Position to start moving at</param>
<returns>The absolute position within the data</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Reads a specified number of bytes into the given buffer
</summary>
<param name="buffer">Buffer to be filled</param>
<param name="offset">First position in the buffer to be filled</param>
<param name="count">Number of bytes to be read</param>
<returns>The actual number of bytes read</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.GetContentType">
<summary>
Gets the content type of this source's content
</summary>
<returns>ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlSource.GetInformation">
<summary>
Gets the SourceInfo
</summary>
<returns>SourceInfo of this StreamSource</returns>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlSource.root">
<summary>
Gets the page's root (html-element)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlSource.head">
<summary>
Gets the page's head node
</summary>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlSource.body">
<summary>
Gets the page's body node
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.HtmlNode">
<summary>
Class that represents a single element node within an html page
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.#ctor(System.String)">
<summary>
Initializes a new HtmlNode
</summary>
<param name="name">Node's name</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.#ctor(System.String,System.Boolean)">
<summary>
Initializes a new HtmlNode
</summary>
<param name="name">Node's name</param>
<param name="hasEndTag">Specifies whether this node has an end tag. For example "br" or "img" do not have one. Remark: Nodes without an end tag must not have a value or sub nodes.</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.#ctor(System.String,System.String)">
<summary>
Initializes a new HtmlNode
</summary>
<param name="name">Node's name</param>
<param name="value">Node's value. Remark: Nodes, containing sub nodes must not have a value.</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNode(InsomniaSoftware.Server.Sources.HtmlNode)">
<summary>
Adds a new sub node
</summary>
<param name="newSubNode">Node to be added</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNode(System.String)">
<summary>
Adds a new sub node
</summary>
<param name="nodeName">Element name of the new node. Does the same as: AddSubNode(new HtmlNode(nodeName))</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNode(System.String,System.Boolean)">
<summary>
Adds a new sub node
</summary>
<param name="nodeName">Element name of the new node. Does the same as: AddSubNode(new HtmlNode(nodeName))</param>
<param name="hasEndTag">Specifies whether the new node has an end tag</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNode(System.String,System.String)">
<summary>
Adds a new sub node
</summary>
<param name="nodeName">Element name of the new node. Does the same as: AddSubNode(new HtmlNode(nodeName))</param>
<param name="value">New node's value</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNodeAfter(InsomniaSoftware.Server.Sources.HtmlNode,InsomniaSoftware.Server.Sources.HtmlNode)">
<summary>
Adds a new sub node after an existing one
</summary>
<param name="newSubNode">Node to be added</param>
<param name="nodeAfterWhichItWillBeInserted">Node, after which the new one is inserted</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.AddSubNodeBefore(InsomniaSoftware.Server.Sources.HtmlNode,InsomniaSoftware.Server.Sources.HtmlNode)">
<summary>
Adds a new sub node before an existing one
</summary>
<param name="newSubNode">Node to be added</param>
<param name="nodeBeforeWhichItWillBeInserted">Node, before which the new one is inserted</param>
<returns>The added node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.RemoveSubNode(InsomniaSoftware.Server.Sources.HtmlNode)">
<summary>
Removes a sub node
</summary>
<param name="nodeToRemove">Node which is to be removed</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.RemoveSubNodes">
<summary>
Removes all sub nodes
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.GetSubNodes(System.String)">
<summary>
Queries all sub nodes with a specific name
</summary>
<param name="name">Name of the sub nodes to get. If the parameter is null all sub nodes are returned</param>
<returns>Array, containing the requested nodes</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.GetSubNodes">
<summary>
Requests all sub nodes
</summary>
<returns>Array, containing all sub nodes</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.SetAttribute(System.String,System.String)">
<summary>
Sets an attribute
</summary>
<param name="name">Attribute's name</param>
<param name="value">Value to set. If this is null the attribute is removed.</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlNode.GetAttribute(System.String)">
<summary>
Gets the value of an attribute
</summary>
<param name="name">The name of the attribute to be queried</param>
<returns>The attribute's value. Returns null if the attribute was not found.</returns>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlNode.name">
<summary>
Gets/sets the name of this node
</summary>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlNode.value">
<summary>
Gets/sets the value of this node. Remark: Nodes, containing sub nodes must not have a value.
</summary>
</member>
<member name="P:InsomniaSoftware.Server.Sources.HtmlNode.parentNode">
<summary>
Gets this node's parent node
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.HtmlObjects">
<summary>
A collection of static functions to create common html elements
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.SimpleText(System.String)">
<summary>
Returns a text element
</summary>
<param name="text">Text to be added</param>
<returns>Text node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.LineBreak">
<summary>
Returns a line break element ("br")
</summary>
<returns>BR node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.Link(System.String)">
<summary>
Returns a link element ("a")
</summary>
<param name="destination">Link destination</param>
<returns>Link node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.Image(System.String)">
<summary>
Returns a image element ("img")
</summary>
<param name="src">Image source</param>
<returns>Image node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.Image(System.String,System.Int32)">
<summary>
Returns a image element ("img")
</summary>
<param name="src">Image source</param>
<param name="border">Border size</param>
<returns>Image node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.BoldText(System.String)">
<summary>
Returns a element representing bold text ("b")
</summary>
<param name="text">Text to be added</param>
<returns>Text node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.ItalicText(System.String)">
<summary>
Returns a element representing italic text ("i")
</summary>
<param name="text">Text to be added</param>
<returns>Text node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.UnderlinedText(System.String)">
<summary>
Returns a element representing underlined text ("u")
</summary>
<param name="text">Text to be added</param>
<returns>Text node</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.CSS(System.String)">
<summary>
Returns a CSS (cascading style sheet) element ("style")
</summary>
<param name="sheetContent">Style sheet's content</param>
<returns>Style element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.JavaScript(System.String)">
<summary>
Returns a JavaScript element ("script")
</summary>
<param name="script">Script's content</param>
<returns>Script element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.Form(System.String,System.String)">
<summary>
Returns a form element
</summary>
<param name="method">Submit method. "get" or "post"</param>
<param name="destinationURL">URL to be called on submit</param>
<returns>Form element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.TextInput(System.String,System.String)">
<summary>
Returns an text input element
</summary>
<param name="name">The element's name</param>
<param name="value">Initial value</param>
<returns>Text input element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.TextInput(System.String)">
<summary>
Returns an text input element
</summary>
<param name="name">The element's name</param>
<returns>Text input element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.HiddenInput(System.String,System.String)">
<summary>
Returns a hidden input element
</summary>
<param name="name">The element's name</param>
<param name="value">Element's value</param>
<returns>Hidden input element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.PasswordInput(System.String)">
<summary>
Returns a password input element
</summary>
<param name="name">The element's name</param>
<returns>Text input element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.SubmitButtom">
<summary>
Returns a submit button element
</summary>
<returns>Submit button element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.SubmitButtom(System.String)">
<summary>
Returns a submit button element
<param name="value">Text displayed on the button</param>
</summary>
<returns>Submit button element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.ResetButtom">
<summary>
Returns a reset button element
</summary>
<returns>Reset button element</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.HtmlObjects.ResetButtom(System.String)">
<summary>
Returns a reset button element
</summary>
<param name="value">Text displayed on the button</param>
<returns>Reset button element</returns>
</member>
<member name="T:InsomniaSoftware.Server.SocketState">
<summary>
Enumeration of socket states
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SocketState.Receiving">
<summary>
The socket is currently receiving data
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SocketState.Sending">
<summary>
The socket is currently sending data
</summary>
</member>
<member name="F:InsomniaSoftware.Server.SocketState.Idle">
<summary>
The socket is currently idle
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.InternalRedirectSource">
<summary>
Static class which contains the GetSource callback for an internal redirection
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.InternalRedirectSource.GetSource(System.String,InsomniaSoftware.Server.HttpRequest,System.Object,InsomniaSoftware.Server.Sources.Source@)">
<summary>
Gets a source which redirects the request to another server-internal location
</summary>
<param name="subPath">/</param>
<param name="request">Request handle</param>
<param name="redirectToLocation">Location to which the request is to be redirected</param>
<param name="source">Source output</param>
<returns>ObjectType of the redirected object</returns>
</member>
<member name="T:InsomniaSoftware.Server.HttpParameter">
<summary>
Base class for a http request parameter
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpParameter.encodingFixed">
<summary>
Indicates whether the encoding has been set by request header. If so it can not be modified
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.#ctor(System.String,System.Byte[],InsomniaSoftware.Server.ParameterSource,System.Text.Encoding)">
<summary>
Constructor for a HttpParameter
</summary>
<param name="name">The parameter's name</param>
<param name="rawValue">The parameter's raw value</param>
<param name="source">Source of the paramter</param>
<param name="defaultStringEncoding">The parameter's default encoding, when requested as string</param>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.FromRaw(System.String,System.Byte[],InsomniaSoftware.Server.ParameterSource,System.Text.Encoding)">
<summary>
Creates a HttpParameter instance
</summary>
<param name="paramName">The new parameter's name</param>
<param name="rawValue">New parameter's raw value</param>
<param name="source">Parameter's source</param>
<param name="defaultStringEncoding">The parameter's default encoding, when requested as string</param>
<returns>The new parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.FromString(System.String,System.String,InsomniaSoftware.Server.ParameterSource,System.Text.Encoding)">
<summary>
Creates a HttpParameter instance
</summary>
<param name="paramName">The new parameter's name</param>
<param name="value">New parameter's value</param>
<param name="source">Parameter's source</param>
<param name="defaultStringEncoding">The parameter's default encoding, when requested as string</param>
<returns>The new parameter</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.ToString">
<summary>
Gets the parameter's value formatted as a string
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.ValueToString">
<summary>
Gets the parameter's value formatted as a string
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.HttpParameter.UpdateEncoding">
<summary>
The default string encoding has changed. Update value
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpParameter.name">
<summary>
Gets the parameter's name
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpParameter.rawValue">
<summary>
Gets the variable's raw value
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpParameter.defaultEncoding">
<summary>
Gets the parameter's default encoding, when it is requested as string
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpParameter.source">
<summary>
Gets the source of this parameter
</summary>
</member>
<member name="T:InsomniaSoftware.Server.StringParameter">
<summary>
Represents a string parameter
</summary>
</member>
<member name="M:InsomniaSoftware.Server.StringParameter.ValueToString">
<summary>
Gets the parameter's value
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.StringParameter.UpdateEncoding">
<summary>
Updates the string's encoding
</summary>
</member>
<member name="P:InsomniaSoftware.Server.StringParameter.value">
<summary>
The parameter's value
</summary>
</member>
<member name="T:InsomniaSoftware.Server.BinaryParameter">
<summary>
Represents a binary parameter
</summary>
</member>
<member name="M:InsomniaSoftware.Server.BinaryParameter.ValueToString">
<summary>
Gets the parameter's value
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.BinaryParameter.UpdateEncoding">
<summary>
Not necessarry
</summary>
</member>
<member name="T:InsomniaSoftware.Server.IntParameter">
<summary>
Represents an integer parameter
</summary>
</member>
<member name="M:InsomniaSoftware.Server.IntParameter.ValueToString">
<summary>
Gets the parameter's value formatted as a string
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.IntParameter.UpdateEncoding">
<summary>
Not necessarry
</summary>
</member>
<member name="P:InsomniaSoftware.Server.IntParameter.value">
<summary>
The parameter's value
</summary>
</member>
<member name="T:InsomniaSoftware.Server.FloatParameter">
<summary>
Represents a floating-point parameter
</summary>
</member>
<member name="M:InsomniaSoftware.Server.FloatParameter.ValueToString">
<summary>
Gets the parameter's value formatted as a string
</summary>
<returns>Parameter's value</returns>
</member>
<member name="M:InsomniaSoftware.Server.FloatParameter.UpdateEncoding">
<summary>
Not necessarry
</summary>
</member>
<member name="P:InsomniaSoftware.Server.FloatParameter.value">
<summary>
The parameter's value
</summary>
</member>
<member name="T:InsomniaSoftware.Server.ParameterSource">
<summary>
Enumeration of sources a parameter can come from
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ParameterSource.Url">
<summary>
From the url string (GET)
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ParameterSource.Content">
<summary>
From the request's content (POST)
</summary>
</member>
<member name="F:InsomniaSoftware.Server.ParameterSource.Cookie">
<summary>
From a cookie
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.GetSourceCallback">
<summary>
Delegate for content source response handling
</summary>
<param name="subPath">The requested file's path relative to the MultiFileSource / The SingeFileSource's name</param>
<param name="request">The request which is to be answered</param>
<param name="userData">User defined data that was passed to AddSource</param>
<param name="source">Source output</param>
<returns>ObjectType of the object</returns>
</member>
<member name="T:InsomniaSoftware.Server.Sources.ObjectType">
<summary>
Enumeration of types of objects returned by sources
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.ObjectType.NotFound">
<summary>
The requested object has not been found
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.ObjectType.File">
<summary>
The requested object is a file
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.ObjectType.Folder">
<summary>
The requested object is a folder
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.CookieDescriptor">
<summary>
Describes a cookie
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.CookieDescriptor.name">
<summary>
The cookie's name
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.CookieDescriptor.value">
<summary>
Value of the cookie to be set
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.CookieDescriptor.#ctor(System.String,System.String)">
<summary>
Constructor
</summary>
<param name="name">The cookie's name</param>
<param name="value">Value of the cookie to be set</param>
</member>
<member name="T:InsomniaSoftware.Server.Sources.SourceInfo">
<summary>
Represents information about a source
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.status">
<summary>
Status code of the response
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.keepConnectionAlive">
<summary>
Keep the connection alive after processing this request?
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.additionalHeaders">
<summary>
Additional headers to be added to the response
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.cookies">
<summary>
Cookies to be sent to the client
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.allowResume">
<summary>
True, if the source allows to be resumed later or to be sent in parts (byte-ranges). False, if not.
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.lastModified">
<summary>
Last modification date of the source's content
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Sources.SourceInfo.eTag">
<summary>
Tag of the source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.SourceInfo.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.SourceInfo.#ctor(InsomniaSoftware.Server.HttpStatus)">
<summary>
Constructor
</summary>
<param name="status">Status code of the response</param>
</member>
<member name="T:InsomniaSoftware.Server.Log">
<summary>
Represents a log book
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Log.Finalize">
<summary>
Destructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Log.Dispose">
<summary>
Disposes the log
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Log.SetLoggingStream(System.IO.Stream)">
<summary>
Sets an stream to which all messages are written
</summary>
<param name="stream">Stream to be written to</param>
</member>
<member name="M:InsomniaSoftware.Server.Log.WriteLine(System.String,System.Int32,System.Boolean)">
<summary>
Writes a line to the log
</summary>
<param name="text">Text to be written</param>
<param name="startPos">Position to start writing (Everything before this position is filled with spaces)</param>
<param name="timeStamp">True if a time stamp should be written</param>
<returns>Firsts character written characters index (possibly for later "startPos" uses)</returns>
</member>
<member name="M:InsomniaSoftware.Server.Log.WriteLine(System.String)">
<summary>
Writes a line to the log
</summary>
<param name="text">Text to be written</param>
<returns>Firsts character written characters index (possibly for later "startPos" uses)</returns>
</member>
<member name="M:InsomniaSoftware.Server.Log.WriteLine(System.String,System.Int32)">
<summary>
Writes a line to the log
</summary>
<param name="text">Text to be written</param>
<param name="startPos">Position to start writing (Everything before this position is filled with spaces)</param>
<returns>Firsts character written characters index (possibly for later "startPos" uses)</returns>
</member>
<member name="M:InsomniaSoftware.Server.Log.WriteLine(System.String,System.Boolean)">
<summary>
Writes a line to the log
</summary>
<param name="text">Text to be written</param>
<param name="timeStamp">True if a time stamp should be written</param>
<returns>Firsts character written characters index (possibly for later "startPos" uses)</returns>
</member>
<member name="E:InsomniaSoftware.Server.Log.OnAddLogEntry">
<summary>
Event which is fired when a new log entry has been added
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Log.LogEntryAdded">
<summary>
Delegate for the OnAddLogEntry event
</summary>
<param name="text">The text which is added to the log</param>
</member>
<member name="T:InsomniaSoftware.Server.InsomniaServer">
<summary>
InsomniaServer main class
- starting point for everything you will want to do
</summary>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.#ctor">
<summary>
Initialize InsomniaServer
</summary>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.#ctor(System.Net.IPEndPoint)">
<summary>
Initialize InsomniaServer and directly set an end point
</summary>
<param name="endPoint">End point (ip and port)</param>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.Finalize">
<summary>
Destructor - clean up InsomniaServer memory
</summary>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.Dispose">
<summary>
Dispose objects and memory used by InsomniaServer
</summary>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.AddEndPoint(System.Net.IPEndPoint)">
<summary>
Adds an extra end point
</summary>
<param name="endPoint">End point to add</param>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.RemoveEndPoint(System.Net.IPEndPoint)">
<summary>
Removes an end point
</summary>
<param name="endPoint">End point to remove</param>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.Start">
<summary>
Start the server and enable clients to connect
</summary>
</member>
<member name="M:InsomniaSoftware.Server.InsomniaServer.Stop">
<summary>
Stop the server (pause)
</summary>
</member>
<member name="P:InsomniaSoftware.Server.InsomniaServer.idleConnectionHandler">
<summary>
The IdleConnectionHandler observes all connection and closes idle connections which did time-out
</summary>
</member>
<member name="P:InsomniaSoftware.Server.InsomniaServer.fileSystem">
<summary>
The server's file system
- if you want to add/remove sources, this is where you go
</summary>
</member>
<member name="P:InsomniaSoftware.Server.InsomniaServer.serverName">
<summary>
Server's name as it is sent to the client in every response
</summary>
</member>
<member name="P:InsomniaSoftware.Server.InsomniaServer.sessionManager">
<summary>
The SessionManager for this server instance
</summary>
</member>
<member name="P:InsomniaSoftware.Server.InsomniaServer.log">
<summary>
Class handling the server's log files
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Sources.MovedPermanentlySource">
<summary>
Represents a source which tells the client that the requested content permanently has moved to a new location
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.GetSource(System.String,InsomniaSoftware.Server.HttpRequest,System.Object,InsomniaSoftware.Server.Sources.Source@)">
<summary>
GetSource callback for direct insertion to FSNode.AddSource
</summary>
<param name="subPath">Sub path of the requested object</param>
<param name="request">The belonging HttpRequest</param>
<param name="newLocation">Location the request is to be redirected to</param>
<param name="source">Out parameter: source</param>
<returns>Always ObjectType.File</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="newLocation">Location to which the request is to be redirected</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.GetLength">
<summary>
Returns the content's length
</summary>
<returns>Content length (always 0)</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Simply returns zero as this function is senseless in this kind of source
</summary>
<param name="offset">/</param>
<param name="origin">/</param>
<returns>0</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Simply returns zero as this function is senseless in this kind of source
</summary>
<param name="buffer">/</param>
<param name="offset">/</param>
<param name="count">/</param>
<returns>0</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.MovedPermanentlySource.GetInformation">
<summary>
Requests the source's information for the redirection
</summary>
<returns>SourceInfo data</returns>
</member>
<member name="T:InsomniaSoftware.Server.HttpConnection">
<summary>
This class manages requests from the belonging socket
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpConnection.lastSocketAccessTime">
<summary>
Last time the connection's socket was accessed
</summary>
</member>
<member name="F:InsomniaSoftware.Server.HttpConnection.lastProcessedRequestId">
<summary>
Id of the request which has been processed most lately
</summary>
</member>
<member name="M:InsomniaSoftware.Server.HttpConnection.Close">
<summary>
Close this connection - shut down the belonging socket
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.server">
<summary>
Handle to the belonging server instance
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.timeout">
<summary>
Connection's timeout in seconds
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.dataAvailable">
<summary>
Gets whether data can be read from the socket or not
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.socketShutDown">
<summary>
Gets whether the socket was already shut down and is not accessible anymore
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.state">
<summary>
Belonging socket's state
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.handlingRequests">
<summary>
Gets if the connection is handling a request at the current moment
</summary>
</member>
<member name="P:InsomniaSoftware.Server.HttpConnection.id">
<summary>
Connection's server-unique id
</summary>
</member>
<member name="T:InsomniaSoftware.Server.Tools.HttpTools">
<summary>
Provides static methods for common http tasks
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.DecodeHttpString(System.String,System.Text.Encoding)">
<summary>
Transforms an http encoded string into a normal one
</summary>
<param name="httpString">Http encoded string</param>
<param name="encoding">Encoding to use</param>
<returns>Decoded string</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.EncodeHttpString(System.String,System.Text.Encoding)">
<summary>
Encodes a string for http usage
</summary>
<param name="inputStr">String to be encoded</param>
<param name="encoding">Encoding to use</param>
<returns>Encoded string</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.EncodeHtmlString(System.String)">
<summary>
Encodes a string for usage within an html page
</summary>
<param name="inputStr">String to be encoded</param>
<returns>Encoded string</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.RemoveQuotes(System.String)">
<summary>
Removes quotes from an string (e.g. "Hello" -> Hello)
</summary>
<param name="inputString">Quoted string</param>
<returns>De-quoted string</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.EncodeHttpTime(System.DateTime)">
<summary>
Encodes a time for http usage
</summary>
<param name="time">Time to encode</param>
<returns>Http time string</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.HttpTools.DecodeHttpTime(System.String)">
<summary>
Decodes a time from an http time string
</summary>
<param name="timeStr">Http time string</param>
<returns>Decoded time</returns>
</member>
<member name="T:InsomniaSoftware.Server.Tools.InteropTools">
<summary>
Provides functions of the Win32 API
</summary>
</member>
<member name="F:InsomniaSoftware.Server.Tools.InteropTools.performanceCounterFrequency">
<summary>
Ticks per second of the performance counter
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Tools.InteropTools.QueryPerformanceCounter(System.Int64@)">
<summary>
Queries the current performance counter value
</summary>
<param name="performanceCount">Variable in which the output value is to be stored</param>
<returns>True if the query succeeded, false if not</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.InteropTools.QueryPerformanceCounter">
<summary>
Queries the current performance counter value
</summary>
<returns>Current value</returns>
</member>
<member name="M:InsomniaSoftware.Server.Tools.InteropTools.StrFormatByteSize(System.Int64,System.Text.StringBuilder,System.Int32)">
<summary>
Formats a file size to a easily readable string (e.g. 1050 -> 1kB)
</summary>
<param name="fileSize">The byte number to be formatted</param>
<param name="buffer">Output string buffer</param>
<param name="bufferSize">The string buffer's size</param>
</member>
<member name="T:InsomniaSoftware.Server.Sources.NoContentSource">
<summary>
Represents a object without any content which can be used to simulate HTTP status responses (No content / Not modified / ...)
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.#ctor">
<summary>
Creates a standard contentless source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.#ctor(InsomniaSoftware.Server.ContentType)">
<summary>
Creates a contentless source
</summary>
<param name="type">ContentType of the response</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.#ctor(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Creates a contentless source
</summary>
<param name="type">ContentType of the response</param>
<param name="info">SourceInfo of the created source</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.#ctor(InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.HttpStatus)">
<summary>
Creates a contentless source
</summary>
<param name="type">ContentType of the response</param>
<param name="status">The response's HttpStatus</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.#ctor(InsomniaSoftware.Server.ContentType,System.Int32,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Creates a contentless source sending a content length
</summary>
<param name="type">ContentType of the response</param>
<param name="contentLength">Content length to be sent</param>
<param name="info">SourceInfo of the created source</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.GetLength">
<summary>
Returns the content's length
</summary>
<returns>Content length (always 0)</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Simply returns zero as this function is senseless in this kind of source
</summary>
<param name="offset">/</param>
<param name="origin">/</param>
<returns>0</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Simply returns zero as this function is senseless in this kind of source
</summary>
<param name="buffer">/</param>
<param name="offset">/</param>
<param name="count">/</param>
<returns>0</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.GetContentType">
<summary>
Requests the response's content type
</summary>
<returns>Specified content type</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.NoContentSource.GetInformation">
<summary>
Requests the source's information
</summary>
<returns>SourceInfo data</returns>
</member>
<member name="T:InsomniaSoftware.Server.Sources.FileSource">
<summary>
Static class representing a file source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.FileSource.Get(System.String)">
<summary>
Gets a StreamSource containing a file
</summary>
<param name="filePath">Path of the file to represent</param>
<returns>The requested StreamSource</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.FileSource.Get(System.String,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Gets a StreamSource containing a file
</summary>
<param name="filePath">Path of the file to represent</param>
<param name="info">SourceInfo for the created source</param>
<returns>The requested StreamSource</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.FileSource.Get(System.String,InsomniaSoftware.Server.ContentType)">
<summary>
Gets a StreamSource containing a file
</summary>
<param name="filePath">Path of the file to represent</param>
<param name="contentType">The response's content type (no matter the file's extension)</param>
<returns>The requested StreamSource</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.FileSource.Get(System.String,InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Gets a StreamSource containing a file
</summary>
<param name="filePath">Path of the file to represent</param>
<param name="contentType">The response's content type (no matter the file's extension)</param>
<param name="info">SourceInfo for the created source</param>
<returns>The requested StreamSource</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.FileSource.GetSource(System.String,InsomniaSoftware.Server.HttpRequest,System.Object,InsomniaSoftware.Server.Sources.Source@)">
<summary>
GetSource callback for direct insertion to FSNode.AddSource
</summary>
<param name="subPath">Sub path of the requested object</param>
<param name="request">The belonging HttpRequest</param>
<param name="filePath">Path of the file to be sent</param>
<param name="source">Out parameter: source</param>
<returns>ObjectType.File if the file was opened properly, ObjectType.NotFound if not</returns>
</member>
<member name="T:InsomniaSoftware.Server.Sources.BinarySource">
<summary>
Represents a Source which contains binary data
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.#ctor(System.Byte[],InsomniaSoftware.Server.ContentType)">
<summary>
Constructor
</summary>
<param name="data">Binary data to be represented</param>
<param name="contentType">Content type of the data</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.#ctor(System.Byte[],InsomniaSoftware.Server.ContentType,InsomniaSoftware.Server.Sources.SourceInfo)">
<summary>
Constructor
</summary>
<param name="data">Binary data to be represented</param>
<param name="contentType">Content type of the data</param>
<param name="info">SourceInfo for the source</param>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.Finalize">
<summary>
Destructor
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.Dispose">
<summary>
Disposes this source
</summary>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.GetLength">
<summary>
Gets the length of the source's content
</summary>
<returns>Content length</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.Seek(System.Int32,System.IO.SeekOrigin)">
<summary>
Moves current the position withing the binary data
</summary>
<param name="offset">Offset by which the location will move</param>
<param name="origin">Position to start moving at</param>
<returns>The absolute position within the data</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.Read(System.Byte[]@,System.Int32,System.Int32)">
<summary>
Reads a specified number of bytes into the given buffer
</summary>
<param name="buffer">Buffer to be filled</param>
<param name="offset">First position in the buffer to be filled</param>
<param name="count">Number of bytes to be read</param>
<returns>The actual number of bytes read</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.GetContentType">
<summary>
Gets the content type of this source's content
</summary>
<returns>ContentType instance</returns>
</member>
<member name="M:InsomniaSoftware.Server.Sources.BinarySource.GetInformation">
<summary>
Gets the SourceInfo
</summary>
<returns>SourceInfo of this BinarySource</returns>
</member>
</members>
</doc>
Submit an article or tip