provider

Documentation

Index

• type IProvider
  • func New(opts ...Option) IProvider
• type Option
  • func WithConfig(config config.IConfig) Option
  • func WithJob(job job.IJob) Option
  • func WithPkg(pkg pkg.IPkg) Option
  • func WithRedis(redis *redis.Pool) Option
  • func WithRepo(repo repo.IRepo) Option
  • func WithUseCase(usecase usecase.IUseCase) Option
• type Provider
  • func (provider *Provider) DoSendNotification(job *work.Job) (err error)
  • func (provider *Provider) Export(job *work.Job) error
  • func (provider *Provider) Hcheck(job *work.Job) (err error)
  • func (provider *Provider) Log(job *work.Job, next work.NextMiddlewareFunc) error

Types

type IProvider

type IProvider interface {
	// Log is used for printing the Log.
	// It returns any errors written.
	Log(job *work.Job, next work.NextMiddlewareFunc) error

	// Export is used for Checkins the queue.
	// It returns any errors written.
	Export(job *work.Job) error

	// DoSendNotification is used for sending notifications with Onesignal.
	// It returns any errors written.
	DoSendNotification(job *work.Job) (err error)

	// Hcheck is used for checking health of redis connection.
	// It returns any errors written.
	Hcheck(job *work.Job) (err error)
}

IProvider is an interface that stores the methods that Provider struct will use.

func New

func New(opts ...Option) IProvider

New it returns instance of Provider that implements IProvider methods.

type Option

type Option func(provider *Provider)

Option ...

func WithConfig

func WithConfig(config config.IConfig) Option

WithConfig ...

func WithJob

func WithJob(job job.IJob) Option

WithJob ...

func WithPkg

func WithPkg(pkg pkg.IPkg) Option

WithPkg ...

func WithRedis

func WithRedis(redis *redis.Pool) Option

WithRedis ...

func WithRepo

func WithRepo(repo repo.IRepo) Option

WithRepo ...

func WithUseCase

func WithUseCase(usecase usecase.IUseCase) Option

WithUseCase ...

type Provider

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

Provider is an struct that implements IProvider methods.

func (*Provider) DoSendNotification

func (provider *Provider) DoSendNotification(job *work.Job) (err error)

DoSendNotification is used for sending notifications with Onesignal. It returns any errors written.

func (*Provider) Export

func (provider *Provider) Export(job *work.Job) error

Export is used for Checkins the queue. It returns any errors written.

func (*Provider) Hcheck

func (provider *Provider) Hcheck(job *work.Job) (err error)

Hcheck is used for checking health of redis connection. It returns any errors written.

func (*Provider) Log

func (provider *Provider) Log(job *work.Job, next work.NextMiddlewareFunc) error

Log is used for printing the Log. It returns any errors written.