This topic has not yet been rated - Rate this topic

SimpleWorkerRequest Class

Provides a simple implementation of the HttpWorkerRequest abstract class that can be used to host ASP.NET applications outside an Internet Information Services (IIS) application. You can employ SimpleWorkerRequest directly or extend it.

System.Object
  System.Web.HttpWorkerRequest
    System.Web.Hosting.SimpleWorkerRequest

Namespace:  System.Web.Hosting
Assembly:  System.Web (in System.Web.dll)
[ComVisibleAttribute(false)]
public class SimpleWorkerRequest : HttpWorkerRequest

The SimpleWorkerRequest type exposes the following members.

  Name Description
Public method SimpleWorkerRequest(String, String, TextWriter) Initializes a new instance of the SimpleWorkerRequest class when the target application domain has been created using the CreateApplicationHost method.
Public method SimpleWorkerRequest(String, String, String, String, TextWriter) Initializes a new instance of the SimpleWorkerRequest class for use in an arbitrary application domain, when the user code creates an HttpContext (passing the SimpleWorkerRequest as an argument to the HttpContext constructor).
Top
  Name Description
Public property MachineConfigPath Gets the full physical path to the Machine.config file. (Overrides HttpWorkerRequest.MachineConfigPath.)
Public property MachineInstallDirectory Gets the physical path to the directory where the ASP.NET binaries are installed. (Overrides HttpWorkerRequest.MachineInstallDirectory.)
Public property RequestTraceIdentifier Gets the corresponding Event Tracking for Windows trace ID for the current request. (Inherited from HttpWorkerRequest.)
Public property RootWebConfigPath Gets the full physical path to the root Web.config file. (Overrides HttpWorkerRequest.RootWebConfigPath.)
Top
  Name Description
Public method CloseConnection Terminates the connection with the client. (Inherited from HttpWorkerRequest.)
Public method EndOfRequest Notifies the HttpWorkerRequest that request processing for the current request is complete. (Overrides HttpWorkerRequest.EndOfRequest().)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FlushResponse Sends all pending response data to the client. (Overrides HttpWorkerRequest.FlushResponse(Boolean).)
Public method GetAppPath Returns the virtual path to the currently executing server application. (Overrides HttpWorkerRequest.GetAppPath().)
Public method GetAppPathTranslated Returns the UNC-translated path to the currently executing server application. (Overrides HttpWorkerRequest.GetAppPathTranslated().)
Public method GetAppPoolID Infrastructure. When overridden in a derived class, returns the application pool ID for the current URL. (Inherited from HttpWorkerRequest.)
Public method GetBytesRead Infrastructure. Gets the number of bytes read in from the client. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificate Infrastructure. When overridden in a derived class, gets the certification fields (specified in the X.509 standard) from a request issued by the client. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificateBinaryIssuer Infrastructure. Gets the certificate issuer, in binary format. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificateEncoding Infrastructure. When overridden in a derived class, returns the Encoding object in which the client certificate was encoded. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificatePublicKey Infrastructure. When overridden in a derived class, gets a PublicKey object associated with the client certificate. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificateValidFrom Infrastructure. When overridden in a derived class, gets the date when the certificate becomes valid. The date varies with international settings. (Inherited from HttpWorkerRequest.)
Public method GetClientCertificateValidUntil Infrastructure. Gets the certificate expiration date. (Inherited from HttpWorkerRequest.)
Public method GetConnectionID Infrastructure. When overridden in a derived class, returns the ID of the current connection. (Inherited from HttpWorkerRequest.)
Public method GetFilePath Returns the physical path to the requested URI. (Overrides HttpWorkerRequest.GetFilePath().)
Public method GetFilePathTranslated Returns the physical file path to the requested URI (and translates it from virtual path to physical path: for example, "/proj1/page.aspx" to "c:\dir\page.aspx") (Overrides HttpWorkerRequest.GetFilePathTranslated().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHttpVerbName Returns the HTTP request verb. (Overrides HttpWorkerRequest.GetHttpVerbName().)
Public method GetHttpVersion Returns the HTTP version string of the request (for example, "HTTP/1.1"). (Overrides HttpWorkerRequest.GetHttpVersion().)
Public method GetKnownRequestHeader Returns the standard HTTP request header that corresponds to the specified index. (Inherited from HttpWorkerRequest.)
Public method GetLocalAddress Returns the server IP address of the interface on which the request was received. (Overrides HttpWorkerRequest.GetLocalAddress().)
Public method GetLocalPort Returns the port number on which the request was received. (Overrides HttpWorkerRequest.GetLocalPort().)
Public method GetPathInfo Returns additional path information for a resource with a URL extension. That is, for the path /virdir/page.html/tail, the return value is /tail. (Overrides HttpWorkerRequest.GetPathInfo().)
Public method GetPreloadedEntityBody() Returns the portion of the HTTP request body that has already been read. (Inherited from HttpWorkerRequest.)
Public method GetPreloadedEntityBody(Byte[], Int32) Gets the portion of the HTTP request body that has currently been read by using the specified buffer data and byte offset. (Inherited from HttpWorkerRequest.)
Public method GetPreloadedEntityBodyLength Gets the length of the portion of the HTTP request body that has currently been read. (Inherited from HttpWorkerRequest.)
Public method GetProtocol When overridden in a derived class, returns the HTTP protocol (HTTP or HTTPS). (Inherited from HttpWorkerRequest.)
Public method GetQueryString Returns the query string specified in the request URL. (Overrides HttpWorkerRequest.GetQueryString().)
Public method GetQueryStringRawBytes When overridden in a derived class, returns the response query string as an array of bytes. (Inherited from HttpWorkerRequest.)
Public method GetRawUrl Returns the URL path contained in the header with the query string appended. (Overrides HttpWorkerRequest.GetRawUrl().)
Public method GetRemoteAddress Returns the IP address of the client. (Overrides HttpWorkerRequest.GetRemoteAddress().)
Public method GetRemoteName When overridden in a derived class, returns the name of the client computer. (Inherited from HttpWorkerRequest.)
Public method GetRemotePort Returns the client's port number. (Overrides HttpWorkerRequest.GetRemotePort().)
Public method GetRequestReason Infrastructure. When overridden in a derived class, returns the reason for the request. (Inherited from HttpWorkerRequest.)
Public method GetServerName When overridden in a derived class, returns the name of the local server. (Inherited from HttpWorkerRequest.)
Public method GetServerVariable Returns a single server variable from a dictionary of server variables associated with the request. (Overrides HttpWorkerRequest.GetServerVariable(String).)
Public method GetTotalEntityBodyLength Gets the length of the entire HTTP request body. (Inherited from HttpWorkerRequest.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUnknownRequestHeader Returns a nonstandard HTTP request header value. (Inherited from HttpWorkerRequest.)
Public method GetUnknownRequestHeaders Get all nonstandard HTTP header name-value pairs. (Inherited from HttpWorkerRequest.)
Public method GetUriPath Returns the virtual path to the requested URI. (Overrides HttpWorkerRequest.GetUriPath().)
Public method GetUrlContextID Infrastructure. When overridden in a derived class, returns the context ID of the current connection. (Inherited from HttpWorkerRequest.)
Public method GetUserToken Returns the client's impersonation token. (Overrides HttpWorkerRequest.GetUserToken().)
Public method GetVirtualPathToken Infrastructure. Gets the impersonation token for the request virtual path. (Inherited from HttpWorkerRequest.)
Public method HasEntityBody Returns a value indicating whether the request contains body data. (Inherited from HttpWorkerRequest.)
Public method HeadersSent Returns a value indicating whether HTTP response headers have been sent to the client for the current request. (Inherited from HttpWorkerRequest.)
Public method IsClientConnected Returns a value indicating whether the client connection is still active. (Inherited from HttpWorkerRequest.)
Public method IsEntireEntityBodyIsPreloaded Returns a value indicating whether all request data is available and no further reads from the client are required. (Inherited from HttpWorkerRequest.)
Public method IsSecure Returns a value indicating whether the connection uses SSL. (Inherited from HttpWorkerRequest.)
Public method MapPath Returns the physical path corresponding to the specified virtual path. (Overrides HttpWorkerRequest.MapPath(String).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ReadEntityBody(Byte[], Int32) Reads request data from the client (when not preloaded). (Inherited from HttpWorkerRequest.)
Public method ReadEntityBody(Byte[], Int32, Int32) Reads request data from the client (when not preloaded) by using the specified buffer to read from, byte offset, and maximum bytes. (Inherited from HttpWorkerRequest.)
Public method SendCalculatedContentLength(Int32) Adds a Content-Length HTTP header to the response for message bodies that are less than or equal to 2 GB. (Inherited from HttpWorkerRequest.)
Public method SendCalculatedContentLength(Int64) Adds a Content-Length HTTP header to the response for message bodies that are greater than 2 GB. (Inherited from HttpWorkerRequest.)
Public method SendKnownResponseHeader Adds a standard HTTP header to the response. (Overrides HttpWorkerRequest.SendKnownResponseHeader(Int32, String).)
Public method SendResponseFromFile(IntPtr, Int64, Int64) Adds the contents of the file with the specified handle to the response and specifies the starting position in the file and the number of bytes to send. (Overrides HttpWorkerRequest.SendResponseFromFile(IntPtr, Int64, Int64).)
Public method SendResponseFromFile(String, Int64, Int64) Adds the contents of the file with the specified name to the response and specifies the starting position in the file and the number of bytes to send. (Overrides HttpWorkerRequest.SendResponseFromFile(String, Int64, Int64).)
Public method SendResponseFromMemory(Byte[], Int32) Adds the contents of a byte array to the response and specifies the number of bytes to send. (Overrides HttpWorkerRequest.SendResponseFromMemory(Byte[], Int32).)
Public method SendResponseFromMemory(IntPtr, Int32) Adds the specified number of bytes from a block of memory to the response. (Inherited from HttpWorkerRequest.)
Public method SendStatus Specifies the HTTP status code and status description of the response; for example, SendStatus(200, "Ok"). (Overrides HttpWorkerRequest.SendStatus(Int32, String).)
Public method SendUnknownResponseHeader Adds a nonstandard HTTP header to the response. (Overrides HttpWorkerRequest.SendUnknownResponseHeader(String, String).)
Public method SetEndOfSendNotification Registers for an optional notification when all the response data is sent. (Inherited from HttpWorkerRequest.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

This simple implementation of HttpWorkerRequest provides the request URL and the query string and captures the body of the output into a TextWriter. To achieve richer functionality, such as providing posted content and headers and capturing the response headers or response body as binary data, you should extend SimpleWorkerRequest and override the appropriate HttpWorkerRequest methods.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ