Documentation
¶
Index ¶
- Constants
- type Intermediate
- type Mock
- func (svc *Mock) Error(ctx context.Context) (graph *workflow.Graph, err error)
- func (svc *Mock) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError) (result string, err error)
- func (svc *Mock) MockError(...) *Mock
- func (svc *Mock) MockHandler(...) *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) TaskA(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, err error)
- func (svc *Mock) TaskB(ctx context.Context, flow *workflow.Flow, trigger string) (result string, err error)
- func (svc *Mock) TaskC(ctx context.Context, flow *workflow.Flow, result string) (finalResult string, err error)
- type Service
- func (svc *Service) Error(ctx context.Context) (graph *workflow.Graph, err error)
- func (svc *Service) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError) (result string, 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) TaskA(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, err error)
- func (svc *Service) TaskB(ctx context.Context, flow *workflow.Flow, trigger string) (result string, err error)
- func (svc *Service) TaskC(ctx context.Context, flow *workflow.Flow, result string) (finalResult string, err error)
- type ToDo
Constants ¶
const ( Hostname = errorflowapi.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) (result string, err error)
Handler executes the mock handler.
func (*Mock) MockError ¶
func (svc *Mock) MockError(handler func(ctx context.Context, flow *workflow.Flow, trigger string) (finalResult string, err error)) *Mock
MockError sets up a mock handler for the Error workflow. The handler receives typed inputs from the workflow's state and returns typed outputs. A nil handler clears the mock.
func (*Mock) MockHandler ¶
func (svc *Mock) MockHandler(handler func(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError) (result string, err error)) *Mock
MockHandler sets up a mock handler for Handler.
func (*Mock) MockTaskA ¶
func (svc *Mock) MockTaskA(handler func(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, 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, trigger string) (result string, 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, result string) (finalResult string, 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) TaskA ¶
func (svc *Mock) TaskA(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, err error)
TaskA executes the mock handler.
type Service ¶
type Service struct {
*Intermediate // IMPORTANT: Do not remove
}
Service implements errorflow.verify which exercises onError routing.
func (*Service) Handler ¶
func (svc *Service) Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError) (result string, err error)
Handler runs when TaskB errors. It records the error and produces a recovery result.
func (*Service) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
func (*Service) TaskA ¶
func (svc *Service) TaskA(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, err error)
TaskA passes the trigger through to state.
type ToDo ¶
type ToDo interface {
OnStartup(ctx context.Context) (err error)
OnShutdown(ctx context.Context) (err error)
TaskA(ctx context.Context, flow *workflow.Flow, trigger string) (triggerOut string, err error) // MARKER: TaskA
TaskB(ctx context.Context, flow *workflow.Flow, trigger string) (result string, err error) // MARKER: TaskB
Handler(ctx context.Context, flow *workflow.Flow, onErr *errors.TracedError) (result string, err error) // MARKER: Handler
TaskC(ctx context.Context, flow *workflow.Flow, result string) (finalResult string, err error) // MARKER: TaskC
Error(ctx context.Context) (graph *workflow.Graph, err error) // MARKER: Error
}
ToDo is implemented by the service or mock.
Source Files
Directories