internal

Documentation

Index

• func WithContext(ctx context.Context, ftl FTL) context.Context
• type FTL
  • func FromContext(ctx context.Context) FTL
• type RealFTL
  • func New() *RealFTL
  • func (r *RealFTL) FSMSend(ctx context.Context, fsm, instance string, event any) error
  • func (r *RealFTL) PublishEvent(ctx context.Context, topic string, event any) error

Functions

func WithContext

func WithContext(ctx context.Context, ftl FTL) context.Context

WithContext returns a new context with the FTL instance.

Types

type FTL

type FTL interface {
	// FSMSend sends an event to an instance of an FSM.
	FSMSend(ctx context.Context, fsm, instance string, data any) error

	// PublishEvent sends an event to a pubsub topic.
	PublishEvent(ctx context.Context, topic string, event any) error
}

FTL is the interface that the FTL runtime provides to user code.

In production, the FTL runtime will provide an implementation of this interface that communicates with the Controller over gRPC.

In testing code, the implementation will inject fakes and other test implementations.

func FromContext

func FromContext(ctx context.Context) FTL

FromContext returns the FTL instance from the context.

type RealFTL

type RealFTL struct{}

RealFTL is the real implementation of the internal.FTL interface using the Controller.

func New

func New() *RealFTL

New creates a new RealFTL

func (*RealFTL) FSMSend

func (r *RealFTL) FSMSend(ctx context.Context, fsm, instance string, event any) error

func (*RealFTL) PublishEvent

func (r *RealFTL) PublishEvent(ctx context.Context, topic string, event any) error