poller

package module

v1.0.0-alpha-9095eaa31... Latest Latest Go to latest Published: May 19, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/CherkashinEvgeny/gopoller

README ¶

poller

Golang library for data polling.

About The Project

Poller - small library, that contains basic logic for data polling mechanisms. One of the common library use cases is implementation of outbox pattern.

Features:

laconic api
context package support
concurrency limit

Usage

process := poller.New(3*time.Second, 2, 2, 2, func(ctx context.Context, limit int) ([]poller.Task, bool) {
	return fetchTasksFromDatabase(limit)
})
process.Start()

License

Poller is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Contact

Email: cherkashin.evgeny.viktorovich@gmail.com
Telegram: @evgeny_cherkashin

Documentation ¶

Index ¶

type Poller
- func New(period time.Duration, size int, threshold int, concurrency int, ...) (poller *Poller)
type Task

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Poller ¶

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

func New ¶

func New(
	period time.Duration,
	size int,
	threshold int,
	concurrency int,
	next func(ctx context.Context, limit int) (tasks []Task, hasMore bool),
) (poller *Poller)

func (*Poller) Done ¶

func (p *Poller) Done() <-chan struct{}

func (*Poller) Start ¶

func (p *Poller) Start()

func (*Poller) StartContext ¶

func (p *Poller) StartContext(ctx context.Context)

func (*Poller) Stop ¶

func (p *Poller) Stop()

func (*Poller) StopContext ¶

func (p *Poller) StopContext(ctx context.Context)

type Task ¶

type Task interface {
	Run(ctx context.Context)
}

Source Files ¶

View all Source files

poller.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL