events

Documentation

Index

• func InitDefaults()
• type Stream
  • func NewEventStream(bgCtx context.Context, persistedSpec *apitypes.EventStream, ...) (ees Stream, err error)

Functions

func InitDefaults

func InitDefaults()

Types

type Stream

type Stream 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
}

func NewEventStream

func NewEventStream(
	bgCtx context.Context,
	persistedSpec *apitypes.EventStream,
	connector ffcapi.API,
	persistence persistence.Persistence,
	wsChannels ws.WebSocketChannels,
	initialListeners []*apitypes.Listener,
) (ees Stream, err error)