queue

Documentation

Overview

Package queue provides the ability for Vela to integrate with different supported Queue backends.

Usage:

import "github.com/go-vela/server/queue"

Index

• func ToContext(c Setter, q Service)
• type Service
  • func FromContext(c context.Context) Service
• type Setter

Functions

func ToContext

func ToContext(c Setter, q Service)

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

Types

type Service

type Service interface {

	// Publish defines a function that inserts an
	// item to the specified route in the queue.
	Publish(string, []byte) error

	// Publish defines a function that decides which
	// route a build gets placed within the queue.
	Route(*pipeline.Worker) (string, error)
}

Service represents the interface for Vela integrating with the different supported Queue backends.

func FromContext

func FromContext(c context.Context) Service

FromContext returns the queue Service associated with this context.

type Setter

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

Setter defines a context that enables setting values.