Documentation
¶
Index ¶
- Constants
- type Intermediate
- type Mock
- func (svc *Mock) Basic(ctx context.Context) (graph *workflow.Graph, err error)
- func (svc *Mock) MockBasic(...) *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) (path string, err error)
- func (svc *Mock) TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)
- func (svc *Mock) TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)
- type Service
- func (svc *Service) Basic(ctx context.Context) (graph *workflow.Graph, 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) (path string, err error)
- func (svc *Service) TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)
- func (svc *Service) TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error)
- type ToDo
Constants ¶
const ( Hostname = basicflowapi.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) MockBasic ¶
func (svc *Mock) MockBasic(handler func(ctx context.Context, flow *workflow.Flow) (path string, err error)) *Mock
MockBasic sets up a mock handler for the Basic 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) (path 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, path string) (pathOut 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, path string) (pathOut string, err error)) *Mock
MockTaskC sets up a mock handler for TaskC.
func (*Mock) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
type Service ¶
type Service struct {
*Intermediate // IMPORTANT: Do not remove
}
Service implements basicflow.verify which exercises the simplest sequential workflow shape.
func (*Service) OnShutdown ¶
OnShutdown is called when the microservice is shut down.
type ToDo ¶
type ToDo interface {
OnStartup(ctx context.Context) (err error)
OnShutdown(ctx context.Context) (err error)
TaskA(ctx context.Context, flow *workflow.Flow) (path string, err error) // MARKER: TaskA
TaskB(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error) // MARKER: TaskB
TaskC(ctx context.Context, flow *workflow.Flow, path string) (pathOut string, err error) // MARKER: TaskC
Basic(ctx context.Context) (graph *workflow.Graph, err error) // MARKER: Basic
}
ToDo is implemented by the service or mock. The intermediate delegates handling to this interface.
Source Files
Directories