HostingModule
PackageAxial.Hosting
Microsoft Generic Host registration helpers for root Flow applications.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| watchdogWithHeartbeat | Hosting.watchdogWithHeartbeat heartbeatGate variables processId notifier isHealthy | Runs a scheduler heartbeat gated by an optional application health flow. |
| watchdogWith | Hosting.watchdogWith variables processId notifier isHealthy | Runs the scheduler heartbeat with an application-owned progress check; use this to detect stalled work. |
| watchdog | Hosting.watchdog variables processId notifier | Detects a wedged Axial scheduler or starved thread pool; supply watchdogWith isHealthy to tie the watchdog to your application's progress. |
| addApp | Hosting.addApp environmentFactory describeError application services | Registers a root application that owns the Generic Host lifetime. |
| addAppWith | Hosting.addAppWith options environmentFactory describeError application services | Registers a root application with explicit Generic Host completion options. |
Operations
kind:member
Hosting.watchdogWithHeartbeat heartbeatGate variables processId notifier isHealthy
MemberRuns a scheduler heartbeat gated by an optional application health flow. Requires a clock and logger in the environment.
Parameters
| Name | Type | Description |
|---|---|---|
| heartbeatGate | Flow<'env, Never, unit> | |
| variables | IEnvironmentVariables | |
| processId | int | |
| notifier | ISystemdNotifier | |
| isHealthy | Flow<'env, Never, bool> |
Returns
Flow<'env, Never, unit>
kind:member
Runs the scheduler heartbeat with an application-owned progress check; use this to detect stalled work.
Parameters
| Name | Type | Description |
|---|---|---|
| variables | IEnvironmentVariables | |
| processId | int | |
| notifier | ISystemdNotifier | |
| isHealthy | Flow<'env, Never, bool> |
Returns
Flow<'env, Never, unit>
kind:member
Detects a wedged Axial scheduler or starved thread pool; supply watchdogWith isHealthy to tie the watchdog to your application's progress.
Parameters
| Name | Type | Description |
|---|---|---|
| variables | IEnvironmentVariables | |
| processId | int | |
| notifier | ISystemdNotifier |
Returns
Flow<'env, Never, unit>
kind:member
Registers a root application that owns the Generic Host lifetime.
Parameters
| Name | Type | Description |
|---|---|---|
| environmentFactory | IServiceProvider -> 'env | |
| describeError | 'error -> string | |
| application | Flow<'env, 'error, unit> | |
| services | IServiceCollection |
Returns
IServiceCollection
kind:member
Registers a root application with explicit Generic Host completion options.
Parameters
| Name | Type | Description |
|---|---|---|
| options | HostedAppOptions | |
| environmentFactory | IServiceProvider -> 'env | |
| describeError | 'error -> string | |
| application | Flow<'env, 'error, unit> | |
| services | IServiceCollection |
Returns
IServiceCollection