example

README

example protoc-gen-go-temporal usage

1. Start temporal

   temporal server start-dev \
       --dynamic-config-value "frontend.enableUpdateWorkflowExecution=true" \
       --dynamic-config-value "frontend.enableUpdateWorkflowExecutionAsyncAccepted=true"
   

2. In a different terminal, run the worker

   go run examples/example/cmd/main.go worker
   

3. In a different terminal, execute a workflow, signal, query, and update

   # execute a workflow in the background
   go run examples/example/cmd/main.go create-foo --name test -d
   
   # signal the workflow
   go run examples/example/cmd/main.go set-foo-progress -w create-foo/test --progress 5.7
   
   # query the workflow
   go run examples/example/cmd/main.go get-foo-progress -w create-foo/test
   
   # update the workflow
   go run examples/example/cmd/main.go update-foo-progress -w create-foo/test --progress 100
   

Documentation

Index

• type Activities
  • func (a *Activities) Notify(ctx context.Context, req *examplev1.NotifyRequest) error
• type CreateFooWorkflow
  • func (wf *CreateFooWorkflow) Execute(ctx workflow.Context) (*examplev1.CreateFooResponse, error)
  • func (wf *CreateFooWorkflow) GetFooProgress() (*examplev1.GetFooProgressResponse, error)
  • func (wf *CreateFooWorkflow) UpdateFooProgress(ctx workflow.Context, req *examplev1.SetFooProgressRequest) (*examplev1.GetFooProgressResponse, error)
• type Workflows
  • func (w *Workflows) CreateFoo(ctx workflow.Context, input *examplev1.CreateFooWorkflowInput) (examplev1.CreateFooWorkflow, error)

Types

type Activities

type Activities struct{}

Activities manages shared state for activities and is used to register activities with a worker

func (*Activities) Notify

func (a *Activities) Notify(ctx context.Context, req *examplev1.NotifyRequest) error

Notify defines the implementation for a Notify activity

type CreateFooWorkflow

type CreateFooWorkflow struct {
	// it embeds the generated workflow Input type that contains the workflow
	// input and signal helpers
	*examplev1.CreateFooWorkflowInput
	// contains filtered or unexported fields
}

CreateFooWorkflow manages workflow state for a CreateFoo workflow

func (*CreateFooWorkflow) Execute

func (wf *CreateFooWorkflow) Execute(ctx workflow.Context) (*examplev1.CreateFooResponse, error)

Execute defines the entrypoint to a example.v1.Example.CreateFoo workflow

func (*CreateFooWorkflow) GetFooProgress

func (wf *CreateFooWorkflow) GetFooProgress() (*examplev1.GetFooProgressResponse, error)

GetFooProgress defines the handler for a GetFooProgress query

func (*CreateFooWorkflow) UpdateFooProgress

func (wf *CreateFooWorkflow) UpdateFooProgress(ctx workflow.Context, req *examplev1.SetFooProgressRequest) (*examplev1.GetFooProgressResponse, error)

UpdateFooProgress defines the handler for an UpdateFooProgress update

type Workflows

type Workflows struct{}

Workflows manages shared state for workflow constructors and is used to register workflows with a worker

func (*Workflows) CreateFoo

func (w *Workflows) CreateFoo(ctx workflow.Context, input *examplev1.CreateFooWorkflowInput) (examplev1.CreateFooWorkflow, error)

CreateFoo initializes a new examplev1.CreateFooWorkflow value