queueengine

package
v0.59.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2026 License: MIT Imports: 11 Imported by: 0

README

queueengine

import "github.com/kitsunium/sdk/framework/internal/app/queueengine"

Package queueengine is what framework/app/queue plugs into kit: the brokers the framework's consumers' queues run on — the SDK's queue in memory, in the data directory and over SQL, a mailer's outbox on a database sealed in front of the SQL one —, the consumer that delivers them, and the migration of a queue's table (ADR 0179 §1, step 4). The framework's core imports none of the SDK's queue: it reaches it through plug, and a product that declares no topic, no subscription, no watch, no queued command and no outbox on a database links none of it.

Package queueengine — the compile-time proof that the brokers are the framework's.

Index

func BrokerOf

func BrokerOf(b plug.Broker) (queue.Broker, bool)

BrokerOf is the SDK's broker behind b, a queue this package opened: what a mailer's spool keeps its outbox in on a database (ADR 0179 step 6) — the sealed outbox, behind a test's wrapper when it set one —; false for a queue it did not open.

func Enable

func Enable()

Enable plugs the queues' brokers, their consumer and the migration of a queue's table into the framework.

Generated from docs/api by tools/genindex.

Documentation

Overview

Package queueengine is what framework/app/queue plugs into kit: the brokers the framework's consumers' queues run on — the SDK's queue in memory, in the data directory and over SQL, a mailer's outbox on a database sealed in front of the SQL one —, the consumer that delivers them, and the migration of a queue's table (ADR 0179 §1, step 4). The framework's core imports none of the SDK's queue: it reaches it through plug, and a product that declares no topic, no subscription, no watch, no queued command and no outbox on a database links none of it.

Package queueengine — the compile-time proof that the brokers are the framework's.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BrokerOf

func BrokerOf(b plug.Broker) (queue.Broker, bool)

BrokerOf is the SDK's broker behind b, a queue this package opened: what a mailer's spool keeps its outbox in on a database (ADR 0179 step 6) — the sealed outbox, behind a test's wrapper when it set one —; false for a queue it did not open.

func Enable

func Enable()

Enable plugs the queues' brokers, their consumer and the migration of a queue's table into the framework.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL