ResourceHandler Class (original) (raw)
Version 118.6.80
Default implementation of IResourceHandler. This latest implementation provides some simplification, at a minimum you only need to override ProcessRequestAsync. See the project source on GitHub for working examples. used to implement a custom request handler interface. The methods of this class will always be called on the IO thread. Static helper methods are included like FromStream and FromString that make dealing with fixed resources easy.
Inheritance Hierarchy
Namespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 118.6.80.0 (118.6.80.0)
Syntax
public class ResourceHandler : IResourceHandler, IDisposable
public ref class ResourceHandler : IResourceHandler, IDisposable
The ResourceHandler type exposes the following members.
Constructors
| | Name | Description | |
| -------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------------- |
| 
| ResourceHandler | Initializes a new instance of the ResourceHandler class. |
Properties
| | Name | Description | |
| -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 
| AutoDisposeStream | When true the Stream will be Disposed when this instance is Disposed. The default value for this property is false. |
| | Charset | Gets or sets the Charset |
| | ErrorCode | If the ErrorCode is set then the response will be ignored and the errorCode returned. |
| | Headers | Gets or sets the headers. |
| | MimeType | Gets or sets the Mime Type. |
| | ResponseLength | Gets or sets ResponseLength, when you know the size of your Stream (Response) set this property. This is optional. If you use a MemoryStream and don't provide a value here then it will be cast and its size used |
| | StatusCode | Gets or sets the http status code. |
| | StatusText | Gets or sets the status text. |
| | Stream | Gets or sets the resource stream. |
Methods
| | Name | Description | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| | Dispose | Dispose of resources here |
| | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| 
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| 
| ForErrorMessage | Generates a ResourceHandler that has it's StatusCode set |
| | FromByteArray | Creates a IResourceHandler that represents a Byte[], uses CefStreamResourceHandler for reading the data |
| | FromFilePath | Gets the resource from the file path specified. Use the Cef.GetMimeType() helper method to lookup the mimeType if required. Uses CefStreamResourceHandler for reading the data |
| | FromStream | Gets the resource from a stream. |
| | FromString(String, String) | Obsolete. Gets the resource from the string. |
| | FromString(String, Encoding, Boolean, String) | Gets a ResourceHandler that represents a string. Without a Preamble, Cef will use BrowserSettings.DefaultEncoding to load the html. |
| | GetByteArray | Gets a byteArray from the given string using the provided encoding |
| | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| | GetMemoryStream | Gets a MemoryStream from the given string using the provided encoding |
| | GetMimeType | Gets the MIME type of the content. |
| | GetType | Gets the Type of the current instance. (Inherited from Object.) |
| | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| | ProcessRequestAsync | Begin processing the request. If you have the data in memory you can execute the callback immediately and return true. For Async processing you would typically spawn a Task to perform processing, then return true. When the processing is complete execute callback.Continue(); In your processing Task, simply set the StatusCode, StatusText, MimeType, ResponseLength and Stream |
| | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
See Also