sfnpoller

Documentation

Overview

Package sfnpoller provides a 'generic' mechanism for to poll a StepFunction state machine for tasks.

Index

• type API
  • func New() *API
  • func (a *API) BeginPolling(parentCtx context.Context) *API
  • func (a *API) Done() <-chan struct{}
  • func (a *API) RegisterTask(task pollableiface.PollableTask) *API
  • func (a *API) Stop()
• type SFNAPI

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is the sfnpoller's API.

func New

func New() *API

New returns a reference to a new sfnpoller API.

func (*API) BeginPolling

func (a *API) BeginPolling(parentCtx context.Context) *API

BeginPolling initiates polling on registered tasks. This method blocks until all all pollers have reported that they have started.

func (*API) Done

func (a *API) Done() <-chan struct{}

Done returns a channel that blocks until all pollers have reported that they are done polling.

func (*API) RegisterTask

func (a *API) RegisterTask(task pollableiface.PollableTask) *API

RegisterTask adds the specified task to the poller's internal list of tasks to execute.

func (*API) Stop

func (a *API) Stop()

Stops them once no activity is available or current activity is finished.

type SFNAPI

type SFNAPI interface {
	GetActivityTask(context.Context, *sfn.GetActivityTaskInput) (*sfn.GetActivityTaskOutput, error)
	SendTaskFailure(context.Context, *sfn.SendTaskFailureInput) (*sfn.SendTaskFailureOutput, error)
	SendTaskHeartbeat(context.Context, *sfn.SendTaskHeartbeatInput) (*sfn.SendTaskHeartbeatOutput, error)
	SendTaskSuccess(context.Context, *sfn.SendTaskSuccessInput) (*sfn.SendTaskSuccessOutput, error)
}