HttpShardManager.ts overview
Since v1.0.0
Exports Grouped by Category
Http App
toHttpApp
Signature
declare const toHttpApp: Effect.Effect<HttpApp.Default<never, Scope>, never, any>
Since v1.0.0
toHttpAppWebsocket
Signature
declare const toHttpAppWebsocket: Effect.Effect<HttpApp.Default<never, Scope>, never, any>
Since v1.0.0
Layers
layerHttp
A HTTP layer for the ShardManager server, that adds a route to the provided HttpRouter.Tag.
By default, it uses the HttpRouter.Default tag.
Signature
declare const layerHttp: Layer.Layer<ShardManager.ShardManager, never, any>
Since v1.0.0
layerHttpOptions
A HTTP layer for the ShardManager server, that adds a route to the provided HttpRouter.Tag.
By default, it uses the HttpRouter.Default tag.
Signature
declare const layerHttpOptions: <I = HttpRouter.Default>(options: {
readonly path: HttpRouter.PathInput
readonly routerTag?: HttpRouter.HttpRouter.TagClass<I, string, any, any>
readonly runnerPath: string
readonly runnerHttps?: boolean | undefined
readonly logAddress?: boolean | undefined
}) => Layer.Layer<
ShardManager.ShardManager,
never,
| RpcSerialization.RpcSerialization
| ShardStorage
| RunnerHealth.RunnerHealth
| HttpClient.HttpClient
| HttpServer.HttpServer
| ShardManager.Config
| ShardingConfig
>
Since v1.0.0
layerNoServerHttp
A layer for the ShardManager service, that does not run a server.
It only provides the Runners rpc client.
You can use this with the toHttpApp and toHttpAppWebsocket apis to run a complete ShardManager server.
Signature
declare const layerNoServerHttp: (options: {
readonly runnerPath: string
readonly runnerHttps?: boolean | undefined
}) => Layer.Layer<
ShardManager.ShardManager,
never,
| RpcSerialization.RpcSerialization
| ShardStorage
| RunnerHealth.RunnerHealth
| HttpClient.HttpClient
| ShardManager.Config
| ShardingConfig
>
Since v1.0.0
layerNoServerWebsocket
A layer for the ShardManager service, that does not run a server.
It only provides the Runners rpc client.
You can use this with the toHttpApp and toHttpAppWebsocket apis to run a complete ShardManager server.
Signature
declare const layerNoServerWebsocket: (options: {
readonly runnerPath: string
readonly runnerHttps?: boolean | undefined
}) => Layer.Layer<
ShardManager.ShardManager,
never,
| RpcSerialization.RpcSerialization
| ShardStorage
| RunnerHealth.RunnerHealth
| Socket.WebSocketConstructor
| ShardManager.Config
| ShardingConfig
>
Since v1.0.0
layerRunnerHealthHttp
Signature
declare const layerRunnerHealthHttp: Layer.Layer<RunnerHealth.RunnerHealth, never, any>
Since v1.0.0
layerRunnerHealthWebsocket
Signature
declare const layerRunnerHealthWebsocket: Layer.Layer<RunnerHealth.RunnerHealth, never, any>
Since v1.0.0
layerWebsocket
A Websocket layer for the ShardManager server, that adds a route to the provided HttpRouter.Tag.
By default, it uses the HttpRouter.Default tag.
Signature
declare const layerWebsocket: Layer.Layer<ShardManager.ShardManager, never, any>
Since v1.0.0
layerWebsocketOptions
A WebSocket layer for the ShardManager server, that adds a route to the provided HttpRouter.Tag.
By default, it uses the HttpRouter.Default tag.
Signature
declare const layerWebsocketOptions: <I = HttpRouter.Default>(options: {
readonly path: HttpRouter.PathInput
readonly routerTag?: HttpRouter.HttpRouter.TagClass<I, string, any, any>
readonly runnerPath: string
readonly runnerHttps?: boolean | undefined
readonly logAddress?: boolean | undefined
}) => Layer.Layer<
ShardManager.ShardManager,
never,
| RpcSerialization.RpcSerialization
| ShardStorage
| RunnerHealth.RunnerHealth
| HttpServer.HttpServer
| Socket.WebSocketConstructor
| ShardManager.Config
| ShardingConfig
>
Since v1.0.0