|Glimpse API Documentation
An abstract IAlternateMethod implementation which handles checking Glimpse policies and timing original implementations.
An abstract IAlternateType T implementation that handles the most common TryCreate scenarios.
An implementation of Castle DynamicProxy'sfor Glimpse.
An implementation of Castle DynamicProxy'sfor Glimpse.
An adapter between Glimpse's IAlternateType T and Castle DynamicProxy's .
The default IHtmlEncoder implementation of Glimpse, which leverages Microsoft's Web Protection Library.
An adapter between Castle DynamicProxy's IAlternateMethodContext.and Glimpse's
An implementation of IExecutionTimer.
The context passed into the Setup method of IInspector.
Athat overrides the way Json.Net handles dictionaries.
An adapter which converts Glimpse's ISerializationConverter to Json.Net .
An implementation of ISerializer which leverages Json.Net.
An abstract base class which provides ILogger implementations with message formatting abilities.
The default implementation of IMessageBroker which supports subscribing to messages based on types, base types and interfaces.
An implementation of ILogger based on NLog.
An attribute used to identify the corresponding NuGet package and Id for an assembly.
An ILogger implementation of the Null Object pattern for use when Glimpse if configured to not use logging.
A collection of commonly used ResourceParameterMetadata objects.
ResourceParameterMetadata describes the parameters for an IResource.
The ISerializationConverter abstraction which makes creating converters that deal with one type easier.
Base implementation that allows simplified the implementation of a tab. NOTE, this implementation is intended for by tabs that can execute on any provider (i.e. aren't bound to HttpContextBase in the case of the ASP.NET provider). Most tabs wont be tied to a specific provider.
Base implementation that allows simplified the implementation of a tab. NOTE, this implementation is intended for by tabs that can only be executed by a specific provider (i.e. ones bound to HttpContextBase in the case of the ASP.NET provider).
The result of a Time method call on a IExecutionTimer.
A subtype of TimerResult which includes the result of non-void method calls.
Definition for an alternate method which allows classes to be proxied.
Definition for the context used by IAlternateMethod
Definition for an alternate that should replace a given Type
IClientScript injects <script> tags into page responses.
IConfigurable allows types to participate in their own configuration.
Definition for the base context that is used by various concepts in the system. Typically uses in place of passing multiple arguments to a method.
Definition for a data store that can be implemented as a storage strategy. This could be used to store request data in memory, to disk or any other source.
Allows a ITab to define what URI it should use if the Tab has supporting documentation.
Definition for an execution timer which will track how long given executions take.
Definition for a html encoder.
Definition of an inspector that runs during startup. This provides the means by which a Tab can setup any listeners, proxies, etc that are needed to gather the data needed the corresponding ITab.
Definition of a context that is used by the IInspector.
IKey provides implementers a means to override the automatically generated key for an object.
Definition of the internal logger that will used by the system.
Definition of the Message Broker that will used by the system.
Definition of a factory that can create proxies of given objects/types. Factory supports wrapping a interfaces, wrapping a class or extending a class.
Wrapping takes a target instance, generates a new type that extends the input types and injects the target object within the new instance. Extends takes a type and generates a new type that extends it.
IResource provides Glimpse clients with data and assets for rendering to the end user.
When implemented, a resource will be discovered and added to the collection of resources.
IRuntimePolicy controls the operations Glimpse is allowed to do an Http request.
When implemented, a policy will be discovered and added to the collection of policies. Together, all policies determine what Glimpse is allowed to do during an Http request.
Definition for the context that is used when a runtime policy is being executed.
Definition for a converter that will provide a custom object representation to serialize for the supported types.
When implemented, a serialization converter will be discovered and added to the collection of serialization converters.
Definition for a provider that can serialize complex objects to JSON.
IStaticClientScript's are a special type of IClientScript that sets the <script> tag's src attribute to a given uri.
Definition for an object which will be represented in the UI as a Tab. To operate you simply need to implement this interface and return an object graph that you would like to view.
When returning data, you can either return the object which represents the Glimpse protocol or return a typed view model. It is recommended that you use typed view models, as it is this object that will be stored in by the Data Store. If this is done, it means that these typed objects can be queried at a latter stage. That said, if you are after simplicity, you can return objects in the shape the Glimpse Protocol requires.
If you do decide to work with a typed view model you can convert this into an objects in the shape the Glimpse Protocol by implementing ISerializationConverter targeting the type of the view model.
Alternatively, if you after simplicity and return an object which represents the Glimpse protocol, you can useand as helpers.
Additional functionality can be injected into via additionally implementing the following interfaces: - : Key that will be used to identify the tab within the client. - : URI that will describe where the documentation for the tab can be found. - : Control how the layout of the content should look. - : Allows tab to inject any hooks it needs within the system. - : Allow complex objects to be converted into the Glimpse protocol.
Definition for the context which tabs use when generating the content will be returned.
Definition for how the layout of a given object can be controlled. When implementing a layout,can be used to make creating the required objects easier.
Definition which allows a tab to inject any hooks it needs within the system.
Definition for the context which is used during tab setup.
IWrapper<T> provides a common way to leverage the decorator pattern.
Used to describe when a given IRuntimePolicy should be executed.
Used to describe what operations Glimpse is allowed to perform during a Http request/response.
The ScriptOrder enumeration specifies the sorting order placement of <script> tags generated by IClientScript's within a page response.