Class PluginsModule

Namespace

Artemis.Core.Services

Assembly

Artemis.Core.dll

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

public class PluginsModule : WebModuleBase, IWebModule

Inheritance

object

ConfiguredObject

WebModuleBase

PluginsModule

Implements

IWebModule

Inherited Members

WebModuleBase.Start(CancellationToken)

WebModuleBase.MatchUrlPath(string)

WebModuleBase.HandleRequestAsync(IHttpContext)

WebModuleBase.OnStart(CancellationToken)

WebModuleBase.BaseRoute

WebModuleBase.OnUnhandledException

WebModuleBase.OnHttpException

WebModuleBase.LogSource

ConfiguredObject.LockConfiguration()

ConfiguredObject.OnBeforeLockConfiguration()

ConfiguredObject.EnsureConfigurationNotLocked()

ConfiguredObject.ConfigurationLocked

Properties

IsFinalHandler

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

public override bool IsFinalHandler { get; }

Property Value

bool

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

public IReadOnlyCollection<PluginEndPoint> PluginEndPoints { get; }

Property Value

IReadOnlyCollection<PluginEndPoint>

Methods

OnRequestAsync(IHttpContext)

Called to handle a request from a client.

protected override Task OnRequestAsync(IHttpContext context)

Parameters

context IHttpContext

The context of the request being handled.

Returns

Task

A Task representing the ongoing operation.