served.utils.events

Undocumented in source.

Members

Enums

onAddedProject
enum onAddedProject

Event called when a new project root is finished setting up. Called when all components are loaded. DCD is loaded but not yet started at this point. Signature: (WorkspaceD.Instance, string dir, string rootFolderUri)

onAddingProject
enum onAddingProject

Event called when a new workspaced instance is created. Called before dub or fsworkspace is loaded. Signature: (WorkspaceD.Instance, string dir, string uri)

onProjectAvailable
enum onProjectAvailable

Event called when a project is available but not intended to be loaded yet. Should not access any components, otherwise it will force a load, but only show hints in the UI. When it's accessed and actually being loaded the events onAddingProject and onAddedProject will be emitted. Signature: (WorkspaceD.Instance, string dir, string uri)

onRegisteredComponents
enum onRegisteredComponents

Event called when all components have been registered but no workspaces have been setup yet. Signature: ()

Mixin templates

EventProcessor
mixintemplate EventProcessor(alias ExtensionModule, EventProcessorConfig config = EventProcessorConfig.init)

Implements the event processor for a given extension module exposing a members field defining all potential methods.

Structs

EventProcessorConfig
struct EventProcessorConfig
Undocumented in source.
postProtocolMethod
struct postProtocolMethod

Called after the @protocolMethod for this method is handled. May have as many handlers registered as needed. When the actual protocol method is a partial method (multiple handlers, returning array) this will be ran on each chunk returned by every handler. In that case the handler will be run multiple times on different fibers.

protocolMethod
struct protocolMethod

Called for requests (not notifications) from the client to the server. This UDA must be used at most once per method for regular methods. For methods returning arrays (T[]) it's possible to register multiple functions with the same method. In this case, if the client supports it, partial results will be sent for each returning method, meaning the results are streamed. In case the client does not support partial methods, all results will be concatenated together and returned as one.

protocolNotification
struct protocolNotification
Undocumented in source.

Meta