worker

Documentation

Overview

Package worker provides the ability for inserting Vela worker resources into or extracting Vela worker resources from the middleware chain for the API.

Usage:

import "github.com/go-vela/server/router/middleware/worker"

Index

• func Establish() gin.HandlerFunc
• func FromContext(c context.Context) *api.Worker
• func Retrieve(c *gin.Context) *api.Worker
• func ToContext(c Setter, w *api.Worker)
• type Setter

Functions

func Establish

func Establish() gin.HandlerFunc

Establish sets the worker in the given context.

func FromContext

func FromContext(c context.Context) *api.Worker

FromContext returns the Worker associated with this context.

func Retrieve

func Retrieve(c *gin.Context) *api.Worker

Retrieve gets the worker in the given context.

func ToContext

func ToContext(c Setter, w *api.Worker)

ToContext adds the Worker to this context if it supports the Setter interface.

Types

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.