service

package
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 9, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package service implements the gRPC service for plugins so plugins can just implement the plugin.Interface and related interfaces.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TaskExecution 

type TaskExecution struct {
	api.UnimplementedTaskExecutionServer

	Impl plugin.Interface
	// contains filtered or unexported fields
}

TaskExecution implements api.TaskExecutionServer and maps incoming gRPC service calls to the plugin.Interface.

func NewGRPCTaskExecution 

func NewGRPCTaskExecution(
	logger hclog.Logger,
	impl plugin.Interface,
) *TaskExecution

NewGRPCTaskExecution returns a new TaskExecution object that will map incoming gRPC service calls to a plugin.Interface implementation.

func (*TaskExecution) Cancel 

func (s *TaskExecution) Cancel(
	ctx context.Context,
	request *api.Task_Cancel_Request,
) (*api.Task_Cancel_Response, error)

Cancel implements the Cancel gRPC service method and performs final cleanup necessary for cancelling a task.

func (*TaskExecution) Complete 

func (s *TaskExecution) Complete(
	ctx context.Context,
	request *api.Task_Complete_Request,
) (*api.Task_Complete_Response, error)

Complete implements the Complete gRPC service method and performs final cleanup necessary for completing a task.

func (*TaskExecution) ExecuteBegin 

func (s *TaskExecution) ExecuteBegin(
	ctx context.Context,
	request *api.Task_SubStage_Request,
) (*api.Task_Operation_Response, error)

func (*TaskExecution) ExecuteCheck 

func (s *TaskExecution) ExecuteCheck(
	ctx context.Context,
	request *api.Task_Operation_Request,
) (*api.Task_Operation_Response, error)

func (*TaskExecution) ExecuteEnd 

func (s *TaskExecution) ExecuteEnd(
	ctx context.Context,
	request *api.Task_SubStage_Request,
) (*api.Task_Operation_Response, error)

func (*TaskExecution) ExecuteFinish 

func (s *TaskExecution) ExecuteFinish(
	ctx context.Context,
	request *api.Task_Operation_Request,
) (*api.Task_Operation_Response, error)

func (*TaskExecution) ExecuteRun 

func (s *TaskExecution) ExecuteRun(
	ctx context.Context,
	request *api.Task_SubStage_Request,
) (*api.Task_Operation_Response, error)

func (*TaskExecution) Goal 

func (s *TaskExecution) Goal(
	ctx context.Context,
	request *api.Task_Goal_Request,
) (*api.Task_Goal_Response, error)

Goal maps the gRPC Goal service method to the Goal method of plugin.Interface.

func (*TaskExecution) Implements 

func (s *TaskExecution) Implements(
	ctx context.Context,
	_ *api.Task_Implements_Request,
) (*api.Task_Implements_Response, error)

Implements maps the gRPC Implements service method to the Implements method of plugin.Interface.

func (*TaskExecution) Prepare 

func (s *TaskExecution) Prepare(
	ctx context.Context,
	request *api.Task_Prepare_Request,
) (*api.Task_Prepare_Response, error)

Prepare maps the gRPC Prepare service method to the Prepare method of plugin.Interface.

func (*TaskExecution) PrepareBegin 

func (s *TaskExecution) PrepareBegin(
	ctx context.Context,
	ref *api.Task_Ref,
) (*api.Task_SubStage_Response, error)

func (*TaskExecution) PrepareEnd 

func (s *TaskExecution) PrepareEnd(
	ctx context.Context,
	ref *api.Task_Ref,
) (*api.Task_SubStage_Response, error)

func (*TaskExecution) PrepareRun 

func (s *TaskExecution) PrepareRun(
	ctx context.Context,
	ref *api.Task_Ref,
) (*api.Task_SubStage_Response, error)

type TaskState 

type TaskState struct {
	// Task is the plugin.Task object that is being executed for this task state.
	Task plugin.Task

	// Context is the plugin.Context used when executing this task.
	Context *plugin.Context
}

TaskState is used to track the task state for a running plugin task.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.