Class PluginsModule

Represents an EmbedIO web module used to process web requests and forward them to the right PluginEndPoint.

Inheritance
object
ConfiguredObject
WebModuleBase
PluginsModule
Implements
IWebModule
Inherited Members
WebModuleBase.HandleRequestAsync(IHttpContext)
WebModuleBase.BaseRoute
WebModuleBase.OnUnhandledException
WebModuleBase.OnHttpException
WebModuleBase.LogSource
ConfiguredObject.LockConfiguration()
ConfiguredObject.OnBeforeLockConfiguration()
ConfiguredObject.EnsureConfigurationNotLocked()
ConfiguredObject.ConfigurationLocked
Namespace: Artemis.Core.Services
Assembly: Artemis.Core.dll
Syntax
public class PluginsModule : WebModuleBase, IWebModule

Properties

IsFinalHandler

Gets a value indicating whether processing of a request should stop after a module has handled it.

Declaration
public override bool IsFinalHandler { get; }
Property Value
Type Description
bool
Overrides
EmbedIO.WebModuleBase.IsFinalHandler
Remarks

If this property is true, a HTTP context's EmbedIO.IHttpContext.SetHandled() method will be automatically called immediately after after the Task returned by EmbedIO.IWebModule.HandleRequestAsync(EmbedIO.IHttpContext) is completed. This will prevent the context from being passed further along to other modules.

See Also
IsHandled
SetHandled()

PluginEndPoints

Gets a read only collection containing all current plugin end points

Declaration
public IReadOnlyCollection<PluginEndPoint> PluginEndPoints { get; }
Property Value
Type Description
IReadOnlyCollection<PluginEndPoint>

Methods

OnRequestAsync(IHttpContext)

Called to handle a request from a client.

Declaration
protected override Task OnRequestAsync(IHttpContext context)
Parameters
Type Name Description
IHttpContext context

The context of the request being handled.
Returns
Type Description
Task

A Task representing the ongoing operation.
Overrides
EmbedIO.WebModuleBase.OnRequestAsync(EmbedIO.IHttpContext)

Implements

EmbedIO.IWebModule