workerpoolhttp

Documentation

Overview

Package workerpoolhttp - реализация очереди http-запросов с обработкой переполнения

Index

• Variables
• type Job
• type Queue
  • func NewQueue(opts *QueueOptions) (*Queue, error)
  • func (q *Queue) AddJob(job *Job)
  • func (q *Queue) Close()
  • func (q *Queue) GetQueue() chan *Job
  • func (q *Queue) Handler(handler http.Handler) http.Handler
• type QueueOptions
• type Worker
  • func NewWorker(queue chan *Job) *Worker
  • func (w *Worker) Run()

Variables

var (
	OptsRequiredErr = errors.New("opts required")
)

Types

type Job

type Job struct {
	W       http.ResponseWriter
	R       *http.Request
	Handler http.Handler
	// contains filtered or unexported fields
}

Job - таск по обработке http запроса

type Queue

type Queue struct {
	// contains filtered or unexported fields
}

Queue - очередь http-запросов

func NewQueue

func NewQueue(opts *QueueOptions) (*Queue, error)

func (*Queue) AddJob

func (q *Queue) AddJob(job *Job)

func (*Queue) Close

func (q *Queue) Close()

func (*Queue) GetQueue

func (q *Queue) GetQueue() chan *Job

func (*Queue) Handler

func (q *Queue) Handler(handler http.Handler) http.Handler

Handler - получение функции для использования в качестве Middleware при настройке маршрутизации запросов

type QueueOptions

type QueueOptions struct {
	QueueSize                         int           // Размер очереди
	Timeout                           time.Duration // Таймаут добавления в очередь
	OverflowCode                      int           // Статус код ошибки переполнения очереди
	OverflowMsg                       proto.Message // Сообщение о переполнении
	OverflowMsgProto, OverflowMsgJson []byte        // Сериализованное сообщение о переполнении
}

QueueOptions - опции очереди

type Worker

type Worker struct {
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker(queue chan *Job) *Worker

func (*Worker) Run

func (w *Worker) Run()

Run - функция, запускающая вечный цикл, который будет слушать очередь до ее закрытия