Documentation
¶
Index ¶
- Constants
- type Intermediate
- type Mock
- func (svc *Mock) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, ...) (attemptsOut int, err error)
- func (svc *Mock) MockHandler(...) *Mock
- func (svc *Mock) MockRetryLoop(...) *Mock
- func (svc *Mock) MockTaskA(...) *Mock
- func (svc *Mock) MockTaskB(...) *Mock
- func (svc *Mock) MockTaskC(...) *Mock
- func (svc *Mock) OnShutdown(ctx context.Context) (err error)
- func (svc *Mock) OnStartup(ctx context.Context) (err error)
- func (svc *Mock) RetryLoop(ctx context.Context) (graph *workflow.Graph, err error)
- func (svc *Mock) TaskA(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error)
- func (svc *Mock) TaskB(ctx context.Context, flow *workflow.Flow, attempts int, target int) (succeeded bool, err error)
- func (svc *Mock) TaskC(ctx context.Context, flow *workflow.Flow, attempts int) (finalAttempts int, err error)
- type Service
- func (svc *Service) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, ...) (attemptsOut int, err error)
- func (svc *Service) Init(initializer func(svc *Service) (err error)) *Service
- func (svc *Service) OnShutdown(ctx context.Context) (err error)
- func (svc *Service) OnStartup(ctx context.Context) (err error)
- func (svc *Service) RetryLoop(ctx context.Context) (graph *workflow.Graph, err error)
- func (svc *Service) TaskA(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error)
- func (svc *Service) TaskB(ctx context.Context, flow *workflow.Flow, attempts, target int) (succeeded bool, err error)
- func (svc *Service) TaskC(ctx context.Context, flow *workflow.Flow, attempts int) (finalAttempts int, err error)
- type ToDo
Constants ¶
const ( Hostname = retryloopflowapi.Hostname Version = 1 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Intermediate ¶
Intermediate extends and customizes the generic base connector.
func NewIntermediate ¶
func NewIntermediate(impl ToDo) *Intermediate
NewIntermediate creates a new instance of the intermediate.
type Mock ¶
type Mock struct {
*Intermediate
// contains filtered or unexported fields
}
Mock is a mockable version of the microservice, allowing functions, event sinks and web handlers to be mocked.
func (*Mock) Handler ¶
func (svc *Mock) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, attempts int) (attemptsOut int, err error)
Handler executes the mock handler.
func (*Mock) MockHandler ¶
func (svc *Mock) MockHandler(handler func(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, attempts int) (attemptsOut int, err error)) *Mock
MockHandler sets up a mock handler for Handler.
func (*Mock) MockRetryLoop ¶
func (svc *Mock) MockRetryLoop(handler func(ctx context.Context, flow *workflow.Flow, target int) (finalAttempts int, err error)) *Mock
MockRetryLoop sets up a mock handler for the RetryLoop workflow. The handler receives typed inputs from the workflow's state and returns typed outputs. A nil handler clears the mock.
func (*Mock) MockTaskA ¶
func (svc *Mock) MockTaskA(handler func(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error)) *Mock
MockTaskA sets up a mock handler for TaskA.
func (*Mock) MockTaskB ¶
func (svc *Mock) MockTaskB(handler func(ctx context.Context, flow *workflow.Flow, attempts int, target int) (succeeded bool, err error)) *Mock
MockTaskB sets up a mock handler for TaskB.
func (*Mock) MockTaskC ¶
func (svc *Mock) MockTaskC(handler func(ctx context.Context, flow *workflow.Flow, attempts int) (finalAttempts int, err error)) *Mock
MockTaskC sets up a mock handler for TaskC.
func (*Mock) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
func (*Mock) RetryLoop ¶
RetryLoop returns the workflow graph, or a mocked graph if MockRetryLoop was called.
func (*Mock) TaskA ¶
func (svc *Mock) TaskA(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error)
TaskA executes the mock handler.
type Service ¶
type Service struct {
*Intermediate // IMPORTANT: Do not remove
}
Service implements retryloopflow.verify, the SKIP-marked OnError retry loop pattern.
func (*Service) Handler ¶
func (svc *Service) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, attempts int) (attemptsOut int, err error)
Handler increments attempts and routes back to B via the normal transition.
func (*Service) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
func (*Service) RetryLoop ¶
RetryLoop defines A -> B -> C with B onError -> Handler -> B (back-edge cycle).
func (*Service) TaskA ¶
func (svc *Service) TaskA(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error)
TaskA passes target through.
type ToDo ¶
type ToDo interface {
OnStartup(ctx context.Context) (err error)
OnShutdown(ctx context.Context) (err error)
TaskA(ctx context.Context, flow *workflow.Flow, target int) (targetOut int, err error) // MARKER: TaskA
TaskB(ctx context.Context, flow *workflow.Flow, attempts, target int) (succeeded bool, err error) // MARKER: TaskB
Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError, attempts int) (attemptsOut int, err error) // MARKER: Handler
TaskC(ctx context.Context, flow *workflow.Flow, attempts int) (finalAttempts int, err error) // MARKER: TaskC
RetryLoop(ctx context.Context) (graph *workflow.Graph, err error) // MARKER: RetryLoop
}
ToDo is implemented by the service or mock.
Source Files
Directories