embedded

Documentation

Overview

Package embedded starts the pathfinding service inside the caller process.

Embedded runs use the same dispatcher and NATS subjects as the standalone command. Callers own the service context and must shut down the returned dispatcher.

Index

• func DefaultConfig() *config.Config
• func DefaultDependencies(ctx context.Context, cfg *config.Config) (*config.Dependencies, error)
• func Run(ctx context.Context, cfg *config.Config, dep *config.Dependencies) (*app.Dispatcher, error)

Functions

func DefaultConfig

func DefaultConfig() *config.Config

DefaultConfig returns the same local defaults used by the standalone service. The values are convenient for embedded/debug runs; callers that embed the service in another deployment should override paths, NATS URL, and grid data.

func DefaultDependencies

func DefaultDependencies(ctx context.Context, cfg *config.Config) (*config.Dependencies, error)

DefaultDependencies builds the default external dependencies for an embedded run. It still connects to NATS and uses a mock ExternalSystem, so production embedders should usually provide their own Dependencies instead or at least change the ExternalSystem for one of their own.

func Run

func Run(ctx context.Context, cfg *config.Config, dep *config.Dependencies) (*app.Dispatcher, error)

Run starts the pathfinding dispatcher in the caller process using the same application path as the standalone service. The returned dispatcher owns the service subscriptions and must be shut down by the caller.