queue

Documentation

Index

• Variables
• type Account
• type Job
• type Queue
  • func NewSimpleQueue(jobTimeout time.Duration, transactionsDoneUpTo time.Duration, cap int32) Queue
• type SimpleQueue
  • func (s *SimpleQueue) Position(j *SimpleQueueJob) int32
  • func (s *SimpleQueue) Process()
  • func (s *SimpleQueue) Set(ctx context.Context, bank string) (Job, bool)
• type SimpleQueueJob
  • func (s *SimpleQueueJob) Credentials(login, pwd []byte, a <-chan string) (q <-chan string)
  • func (s *SimpleQueueJob) Done() <-chan struct{}
  • func (s *SimpleQueueJob) Position() int
  • func (s *SimpleQueueJob) Results() ([]*Account, error)
  • func (s *SimpleQueueJob) Started() <-chan struct{}

Variables

var ErrUnknownBank = errors.New("bank doesn't exist")

Types

type Account

type Account struct {
	Account          *bank.Account
	TransactionsUpTo time.Time
	Transactions     []*bank.Transaction
}

type Job

type Job interface {
	// Position of the job in queue. If it is equal to zero then the job is
	// being or has been processed.
	Position() int
	Started() <-chan struct{}
	Credentials(login, pwd []byte, a <-chan string) (q <-chan string)
	Done() <-chan struct{}
	Results() ([]*Account, error)
}

type Queue

type Queue interface {
	Set(ctx context.Context, bank string) (Job, bool)
}

func NewSimpleQueue

func NewSimpleQueue(jobTimeout time.Duration,
	transactionsDoneUpTo time.Duration, cap int32) Queue

type SimpleQueue

type SimpleQueue struct {
	TransactionsUpTo time.Duration
	JobTimeout       time.Duration

	Queue []*SimpleQueueJob
	// contains filtered or unexported fields
}

func (*SimpleQueue) Position

func (s *SimpleQueue) Position(j *SimpleQueueJob) int32

Position returns the position of the job in queue. If it is equal to zero, the job is being or has been processed.

func (*SimpleQueue) Process

func (s *SimpleQueue) Process()

Process get the first element in queue and run it. This method blocks forever and there is no way to unblock it.

func (*SimpleQueue) Set

func (s *SimpleQueue) Set(ctx context.Context, bank string) (Job, bool)

Set a job in queue. It returns false if the queue is full. This method is thread safe.

type SimpleQueueJob

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

func (*SimpleQueueJob) Credentials

func (s *SimpleQueueJob) Credentials(login, pwd []byte, a <-chan string) (q <-chan string)

Credentials passes the username and password It should be called when the Started method closes. This method is meant to be called a single time so the credentials channel will be closed right after sending the credentials.

func (*SimpleQueueJob) Done

func (s *SimpleQueueJob) Done() <-chan struct{}

func (*SimpleQueueJob) Position

func (s *SimpleQueueJob) Position() int

func (*SimpleQueueJob) Results

func (s *SimpleQueueJob) Results() ([]*Account, error)

Results blocks until the job is done.

func (*SimpleQueueJob) Started

func (s *SimpleQueueJob) Started() <-chan struct{}