scheduler

Documentation

Index

• type ItemCallback
• type QueuedItem
• type Service
  • func New(endpoint string, queueID string) *Service
  • func (s *Service) HandleRequest(ctx *gin.Context) []error
  • func (s *Service) OnRequest(callback ItemCallback)
  • func (s *Service) Queue(ctx context.Context, collection string, id string, at time.Time) error

Types

type ItemCallback

type ItemCallback func(ctx context.Context, item QueuedItem) error

ItemCallback is the type of the callback functions

type QueuedItem

type QueuedItem struct {
	Collection string `json:"collection"`
	ID         string `json:"id"`
}

QueuedItem contains basic data

type Service

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

Service contains the base url for the endpoints

func New

func New(endpoint string, queueID string) *Service

New returns a new Service

func (*Service) HandleRequest

func (s *Service) HandleRequest(ctx *gin.Context) []error

HandleRequest handles the request after it has been returned

func (*Service) OnRequest

func (s *Service) OnRequest(callback ItemCallback)

OnRequest register a callback to trigger when the task is returned

func (*Service) Queue

func (s *Service) Queue(ctx context.Context, collection string, id string, at time.Time) error

Queue a specific message