eventapi

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2025 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EventStream

type EventStream interface {
	AddOrUpdateListener(ctx context.Context, id *fftypes.UUID,
		updates *apitypes.Listener, reset bool) (*apitypes.Listener, error) // Add or update a listener
	RemoveListener(ctx context.Context, id *fftypes.UUID) error          // Stop and remove a listener
	UpdateSpec(ctx context.Context, updates *apitypes.EventStream) error // Apply definition updates (if there are changes)
	Spec() *apitypes.EventStream                                         // Retrieve the merged definition to persist
	Status() apitypes.EventStreamStatus                                  // Get the current status
	Start(ctx context.Context) error                                     // Start delivery
	Stop(ctx context.Context) error                                      // Stop delivery (does not remove checkpoints)
	Delete(ctx context.Context) error                                    // Stop delivery, and clean up any checkpoint

	// For externally managed persistence with API to drive the internal event listener
	PollAPIMangedStream(ctx context.Context, checkpointIn *apitypes.EventStreamCheckpoint, timeout time.Duration) (events []*apitypes.EventWithContext, checkpointOut *apitypes.EventStreamCheckpoint, err error)
}

Jump to

Keyboard shortcuts

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