scheduler

Documentation

Index

• func NewMiddleware() (eh.CommandHandlerMiddleware, chan Error)
• type Command
  • func CommandWithExecuteTime(cmd eh.Command, t time.Time) Command
• type Error
  • func (e Error) Cause() error
  • func (e Error) Error() string
  • func (e Error) Unwrap() error

Functions

func NewMiddleware

func NewMiddleware() (eh.CommandHandlerMiddleware, chan Error)

NewMiddleware returns a new async handling middleware that returns any errors on a error channel.

Types

type Command

type Command interface {
	eh.Command

	// ExecuteAt returns the time when the command will execute.
	ExecuteAt() time.Time
}

Command is a scheduled command with an execution time.

func CommandWithExecuteTime

func CommandWithExecuteTime(cmd eh.Command, t time.Time) Command

CommandWithExecuteTime returns a wrapped command with a execution time set.

type Error

type Error struct {
	// Err is the error that happened when handling the command.
	Err error
	// Ctx is the context used when the error happened.
	Ctx context.Context
	// Command is the command handeled when the error happened.
	Command eh.Command
}

Error is an async error containing the error and the command.

func (Error) Cause

func (e Error) Cause() error

Cause implements the github.com/pkg/errors Unwrap method.

func (Error) Error

func (e Error) Error() string

Error implements the Error method of the error interface.

func (Error) Unwrap

func (e Error) Unwrap() error

Unwrap implements the errors.Unwrap method.