Documentation ¶
Index ¶
- Variables
- func Register(name string, driver Driver)
- type CompleteJobInput
- type CompleteJobOutput
- type Connector
- type ConnectorMock
- func (m *ConnectorMock) Close() error
- func (m *ConnectorMock) CompleteJob(ctx context.Context, input *CompleteJobInput) (*CompleteJobOutput, error)
- func (m *ConnectorMock) Enqueue(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error)
- func (m *ConnectorMock) EnqueueBatch(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error)
- func (m *ConnectorMock) FailJob(ctx context.Context, input *FailJobInput) (*FailJobOutput, error)
- func (m *ConnectorMock) Name() string
- func (m *ConnectorMock) SetLoggerFunc(f LoggerFunc)
- func (m *ConnectorMock) Subscribe(ctx context.Context, input *SubscribeInput) (*SubscribeOutput, error)
- type ConnectorProvider
- func (p *ConnectorProvider) Close()
- func (p *ConnectorProvider) GetActiveConnsInPriorityOrder() []Connector
- func (p *ConnectorProvider) GetConnsInPriorityOrder() []Connector
- func (p *ConnectorProvider) IsDead(conn Connector) bool
- func (p *ConnectorProvider) MarkDead(conn Connector)
- func (p *ConnectorProvider) Register(priority int, conn Connector)
- func (p *ConnectorProvider) SetRetrySeconds(sec time.Duration)
- type CustomAttribute
- type Driver
- type EnqueueBatchEntry
- type EnqueueBatchInput
- type EnqueueBatchOutput
- type EnqueueInput
- type EnqueueOutput
- type FailJobInput
- type FailJobOutput
- type Job
- type JobStat
- type JobWorker
- func (jw *JobWorker) Enqueue(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error)
- func (jw *JobWorker) EnqueueBatch(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error)
- func (jw *JobWorker) ForceExitActiveJob(ctx context.Context) error
- func (jw *JobWorker) GetStats() *Stats
- func (jw *JobWorker) Register(queue string, worker Worker, opts ...OptionFunc)
- func (jw *JobWorker) RegisterFunc(queue string, f WorkerFunc, opts ...OptionFunc)
- func (jw *JobWorker) RegisterOnShutdown(f func())
- func (jw *JobWorker) Shutdown(ctx context.Context) error
- func (jw *JobWorker) Work(s *WorkSetting) error
- func (jw *JobWorker) WorkOnceSafely(ctx context.Context, job *Job)
- type LoggerFunc
- type Option
- type OptionFunc
- type Setting
- type Stats
- type SubscribeInput
- type SubscribeOutput
- type Subscription
- type SubscriptionMock
- type WorkSetting
- type Worker
- type WorkerFunc
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrJobDuplicationDetected = fmt.Errorf("job duplication detected") ErrNoActiveConn = fmt.Errorf("no active conn") )
View Source
var ( ErrPrimaryConnIsRequired = errors.New("primary conn is required") ErrDuplicateEntryID = errors.New("duplicate entry id") )
Functions ¶
Types ¶
type CompleteJobInput ¶
type CompleteJobInput struct {
Job *Job
}
type CompleteJobOutput ¶
type CompleteJobOutput struct{}
type Connector ¶
type Connector interface { Name() string Subscribe(ctx context.Context, input *SubscribeInput) (*SubscribeOutput, error) Enqueue(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error) EnqueueBatch(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error) CompleteJob(ctx context.Context, input *CompleteJobInput) (*CompleteJobOutput, error) FailJob(ctx context.Context, input *FailJobInput) (*FailJobOutput, error) Close() error SetLoggerFunc(f LoggerFunc) }
type ConnectorMock ¶ added in v0.2.2
type ConnectorMock struct { NameFunc func() string SubscribeFunc func(ctx context.Context, input *SubscribeInput) (*SubscribeOutput, error) EnqueueFunc func(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error) EnqueueBatchFunc func(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error) CompleteJobFunc func(ctx context.Context, input *CompleteJobInput) (*CompleteJobOutput, error) FailJobFunc func(ctx context.Context, input *FailJobInput) (*FailJobOutput, error) CloseFunc func() error SetLoggerFuncFunc func(f LoggerFunc) }
func (*ConnectorMock) Close ¶ added in v0.2.2
func (m *ConnectorMock) Close() error
func (*ConnectorMock) CompleteJob ¶ added in v0.2.2
func (m *ConnectorMock) CompleteJob(ctx context.Context, input *CompleteJobInput) (*CompleteJobOutput, error)
func (*ConnectorMock) Enqueue ¶ added in v0.2.2
func (m *ConnectorMock) Enqueue(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error)
func (*ConnectorMock) EnqueueBatch ¶ added in v0.2.2
func (m *ConnectorMock) EnqueueBatch(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error)
func (*ConnectorMock) FailJob ¶ added in v0.2.2
func (m *ConnectorMock) FailJob(ctx context.Context, input *FailJobInput) (*FailJobOutput, error)
func (*ConnectorMock) Name ¶ added in v0.2.2
func (m *ConnectorMock) Name() string
func (*ConnectorMock) SetLoggerFunc ¶ added in v0.2.2
func (m *ConnectorMock) SetLoggerFunc(f LoggerFunc)
func (*ConnectorMock) Subscribe ¶ added in v0.2.2
func (m *ConnectorMock) Subscribe(ctx context.Context, input *SubscribeInput) (*SubscribeOutput, error)
type ConnectorProvider ¶
type ConnectorProvider struct {
// contains filtered or unexported fields
}
func (*ConnectorProvider) Close ¶
func (p *ConnectorProvider) Close()
func (*ConnectorProvider) GetActiveConnsInPriorityOrder ¶ added in v0.2.2
func (p *ConnectorProvider) GetActiveConnsInPriorityOrder() []Connector
func (*ConnectorProvider) GetConnsInPriorityOrder ¶ added in v0.2.2
func (p *ConnectorProvider) GetConnsInPriorityOrder() []Connector
func (*ConnectorProvider) IsDead ¶
func (p *ConnectorProvider) IsDead(conn Connector) bool
func (*ConnectorProvider) MarkDead ¶
func (p *ConnectorProvider) MarkDead(conn Connector)
func (*ConnectorProvider) Register ¶
func (p *ConnectorProvider) Register(priority int, conn Connector)
func (*ConnectorProvider) SetRetrySeconds ¶
func (p *ConnectorProvider) SetRetrySeconds(sec time.Duration)
type CustomAttribute ¶
type EnqueueBatchEntry ¶ added in v0.2.1
type EnqueueBatchInput ¶
type EnqueueBatchInput struct { Queue string Entries []*EnqueueBatchEntry }
type EnqueueBatchOutput ¶
type EnqueueInput ¶
type EnqueueOutput ¶
type EnqueueOutput struct{}
type FailJobInput ¶
type FailJobInput struct {
Job *Job
}
type FailJobOutput ¶
type FailJobOutput struct{}
type Job ¶
type Job struct { Conn Connector QueueName string Content string Metadata map[string]string CustomAttribute map[string]*CustomAttribute Raw interface{} // raw data of different jobs for each connector // contains filtered or unexported fields }
func (*Job) IsFinished ¶
type JobWorker ¶
type JobWorker struct {
// contains filtered or unexported fields
}
func (*JobWorker) Enqueue ¶
func (jw *JobWorker) Enqueue(ctx context.Context, input *EnqueueInput) (*EnqueueOutput, error)
func (*JobWorker) EnqueueBatch ¶
func (jw *JobWorker) EnqueueBatch(ctx context.Context, input *EnqueueBatchInput) (*EnqueueBatchOutput, error)
func (*JobWorker) ForceExitActiveJob ¶ added in v0.4.0
func (*JobWorker) Register ¶
func (jw *JobWorker) Register(queue string, worker Worker, opts ...OptionFunc)
func (*JobWorker) RegisterFunc ¶
func (jw *JobWorker) RegisterFunc(queue string, f WorkerFunc, opts ...OptionFunc)
func (*JobWorker) RegisterOnShutdown ¶
func (jw *JobWorker) RegisterOnShutdown(f func())
func (*JobWorker) Work ¶
func (jw *JobWorker) Work(s *WorkSetting) error
type LoggerFunc ¶
type LoggerFunc func(...interface{})
type Option ¶
func (*Option) ApplyOptions ¶
func (o *Option) ApplyOptions(opts ...OptionFunc)
type OptionFunc ¶ added in v0.2.1
type OptionFunc func(*Option)
func SubscribeMetadata ¶ added in v0.2.1
func SubscribeMetadata(k, v string) OptionFunc
SubscribeMetadata is metadata of subscribe func
type Setting ¶
type Setting struct { Primary Connector Secondary Connector DeadConnectorRetryInterval int64 // Seconds LoggerFunc LoggerFunc }
type SubscribeInput ¶
type SubscribeOutput ¶
type SubscribeOutput struct {
Subscription Subscription
}
type Subscription ¶
type SubscriptionMock ¶ added in v0.2.2
type SubscriptionMock struct { ActiveFunc func() bool QueueFunc func() chan *Job UnSubscribeFunc func() error }
func (*SubscriptionMock) Active ¶ added in v0.2.2
func (m *SubscriptionMock) Active() bool
func (*SubscriptionMock) Queue ¶ added in v0.2.2
func (m *SubscriptionMock) Queue() chan *Job
func (*SubscriptionMock) UnSubscribe ¶ added in v0.2.2
func (m *SubscriptionMock) UnSubscribe() error
type WorkSetting ¶
type WorkerFunc ¶
Source Files ¶
Click to show internal directories.
Click to hide internal directories.